Install CodeRed CLI#

Python#

For Python developers, the easiest way is to install through pip:

pip install cr

Follow our quickstart to create an API key and get started.

Windows#

Supports Windows 10 or higher.

Download for Windows

Download the executable from: https://www.codered.cloud/cli/cr.exe
Open a PowerShell terminal, and run ~/Downloads/cr.exe --help.
Follow our quickstart to create an API key and get started.

Optional: add to PATH

For convenience, copy cr.exe to a folder on your PATH. The following PowerShell script will create a bin folder in your home folder (%USERPROFILE%), download cr.exe into it, and add it to the PATH. Copy/paste this into a PowerShell terminal and press enter.

# Create folder.
New-Item -Type Directory -Force ~/bin
# Download cr.exe
Invoke-WebRequest -OutFile ~/bin/cr.exe "https://www.codered.cloud/cli/cr.exe"
# Add to path.
$p = (Get-Item -Path "Registry::HKEY_CURRENT_USER\Environment").GetValue("Path", "", "DoNotExpandEnvironmentNames") + ";%USERPROFILE%\bin"
Set-ItemProperty -Path "Registry::HKEY_CURRENT_USER\Environment" -Name Path -Value $p

Note

We recommend using the new Windows Terminal for the best experience.

Linux#

Supports most Linux distributions released in 2020 or newer (requires GLIBC 2.29 or higher).

Download for Linux

Download the executable from: https://www.codered.cloud/cli/cr-linux
Move and rename the file to a folder on your PATH, and mark as executable:
```
mv cr-linux /usr/local/bin/cr
chmod +x /usr/local/bin/cr
```
Follow our quickstart to create an API key and get started.

macOS#

Supports macOS 11 or higher.

Download for macOS

Download the executable from: https://www.codered.cloud/cli/cr-macos
If this is your first time using the Terminal app, you may need to allow Terminal to access your files.
Move and rename the file to a folder on your PATH, and mark as executable:
```
mv cr-macos /usr/local/bin/cr
chmod +x /usr/local/bin/cr
```
Follow our quickstart to create an API key and get started.