Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

Only the CLI client needs installation. It is available for Linux, MacOS, and Windows.

Linux

Fedora / RHEL / Rocky / Alma

Add the Corridor Quest repository:

sudo curl -o /etc/yum.repos.d/corridor-quest.repo \
  https://docs.corridor-quest.net/corridor-quest.repo

Install the client:

sudo dnf install cq

openSUSE / SLES

Add the Corridor Quest repository:

sudo curl -o /etc/zypp/repos.d/corridor-quest.repo \
  https://docs.corridor-quest.net/corridor-quest.repo

Install the client:

sudo zypper refresh
sudo zypper install cq

Debian / Ubuntu

Add the repository:

sudo curl -o /etc/apt/sources.list.d/corridor-quest.list \
  https://docs.corridor-quest.net/corridor-quest.list

Install the client:

sudo apt update
sudo apt install cq

Other distributions

Download and extract the tarball for your architecture:

x86_64:

curl -Lo cq.tar.gz https://codeberg.org/api/packages/corridor-quest/generic/cq/latest/cq-linux-x86_64.tar.gz
tar -xzf cq.tar.gz
sudo mv cq-*/cq /usr/local/bin/

arm64:

curl -Lo cq.tar.gz https://codeberg.org/api/packages/corridor-quest/generic/cq/latest/cq-linux-arm64.tar.gz
tar -xzf cq.tar.gz
sudo mv cq-*/cq /usr/local/bin/

Shell completions (optional):

For Bash:

cq completions bash | sudo tee /etc/bash_completion.d/cq > /dev/null

For Zsh (add to ~/.zshrc):

echo 'eval "$(cq completions zsh)"' >> ~/.zshrc

For Fish:

cq completions fish | sudo tee /usr/share/fish/vendor_completions.d/cq.fish > /dev/null

MacOS (Homebrew)

Add the Corridor Quest tap and install:

brew tap corridor-quest/tap https://codeberg.org/corridor-quest/homebrew-tap
brew install cq

To update:

brew update && brew upgrade cq

Windows (8+)

Download and run the installer in PowerShell:

curl.exe -Lo cq.zip https://codeberg.org/api/packages/corridor-quest/generic/cq/latest/cq-windows-x86_64.zip
Expand-Archive cq.zip -DestinationPath cq-install
cd cq-install\cq-*
.\install.ps1

note

Windows 7 users should download the zip manually and run install.ps1 from PowerShell.

Verify installation

To verify proper installation enter these commands in a terminal session:

cq --version
cq --help