Getting started

Install the CLI

Install, update, and remove ntro, the Nitroship CLI.

ntro is the command-line tool for Nitroship. You use it to create apps, deploy, and manage domains and environment variables.

Supported systems: Linux or macOS on amd64 or arm64. The installer uses curl (or wget) and sha256sum (or shasum), which most systems already have.

Run the installer

curl -fsSL https://nitroship.co/install.sh | bash

The installer verifies the download's SHA-256 checksum before installing and never runs sudo on its own. When it finishes, it prints Installed ntro from ...: ntro ....

Add it to your PATH if needed

It installs into /usr/local/bin when that is writable, otherwise into ~/.local/bin. If you saw Add ... to your PATH, ~/.local/bin is not on your PATH yet. Add it as below, then open a new terminal.

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc

Check the installation

ntro --version

If it prints a version, you are done.

Log in

ntro login

Approve the code shown in the browser window that opens. For servers without a browser, or CI, see Log in.

Next: Your first deployment

Update

ntro update --check   # only check whether a new version exists
ntro update           # replace ntro with the latest version

ntro update also verifies the checksum before replacing the executable. If it says it cannot write to the install location, rerun the installer or fix that folder's permissions.

Install somewhere else

Pick the install folder with NITROSHIP_INSTALL_DIR. Make sure that folder is on your PATH.

curl -fsSL https://nitroship.co/install.sh | NITROSHIP_INSTALL_DIR="$HOME/bin" bash

To change the download host (default https://nitroship.co), set NITROSHIP_DOWNLOAD_URL.

Uninstall

ntro is a single executable, so deleting it is enough.

rm "$(command -v ntro)"

Your login data stays in ~/.nitroship. Delete that folder too if you want it gone. See CLI configuration for details.

Troubleshooting

SymptomFix
ntro: command not foundThe install folder is not on your PATH. Follow the PATH step above and open a new terminal.
Unsupported OS or architectureOnly Linux and macOS on amd64 or arm64 are supported.
Checksum mismatchThe download may be corrupted. Run the installer again.

On this page