Command reference

How to read this pageCopy Anchor Link

• <argument> is required; [argument] is optional. In a terminal, leaving out an [argument] makes the CLI ask you to pick or type it. Automation may need to pass it explicitly.
• Tables list only options specific to each command. Common options such as --team and --json are in CLI configuration.
• Options on a command group (builds, domains, env, and so on), such as --app, apply to all of its subcommands.
• Every command shows usage and examples with --help.

Login, status, and updatesCopy Anchor Link

Automatic update notices: at most once a day, ntro checks for a new version in the background and tells you after the command finishes, without slowing the command down. It skips the check with --json, in CI (CI not empty), when stderr is not a terminal, for dev and prerelease builds, and for --help, --version, and shell completion. Set NITROSHIP_NO_UPDATE_NOTIFIER=1 to turn it off.

TeamsCopy Anchor Link

Only the team owner can manage invitations and members. Invitees join only after accepting, and invitations expire after seven days. See Teams and roles for ownership transfer and the full rules. teams is also available as team.

Apps and folder linksCopy Anchor Link

ntro unlink --json prints {"unlinked":true,"appId":"<id>"} (plus teamId when known) after removing a link, or {"unlinked":false} when there was none. How links work is covered in CLI configuration > App links.

DeployCopy Anchor Link

ntro deploy [folder]     # or: ntro [folder]

Running plain ntro with no arguments deploys the current folder.

By default the CLI streams the build log and waits until the deployment is ready or failed. With --json, progress goes to stderr and the result is printed to stdout as one JSON object: a Deployment after waiting, or a Build with --no-wait.

Choosing how to deployCopy Anchor Link

Deployment asset uploads reuse content already stored for the app. Progress shows the file bytes actually sent and how many unchanged files were skipped; Node.js bundles are still uploaded in full. Uploads continue through the Nitroship API, and older servers automatically receive all files.

• --image and --bundle-dir cannot be combined. --bundle-dir always needs --entrypoint.
• --local supports static and node-server presets, plus the dedicated Next.js adapter. It rejects container and container-static presets, including generated static toolchain builders. Dockerfile builds also require hosted builds. Remove --local to let Nitroship build the source. See Build framework.
• Remote builds do not accept compute flags; use App Settings > Compute in the console or nitroship.json. See Compute settings.
• --tier takes a tier name offered by the platform. The default is standard, with others such as large; the available names and their CPU and memory are shown in the console and by GET /v1/compute/options. Disabled tiers cannot be used for new deployments.
• ntro registry login only prints the Docker login command for pushing images to the Nitroship registry (with --json: registry, username, and password). The output contains a password, so keep it out of shared logs.

Manage deployments and logsCopy Anchor Link

All of these accept --app. See Managing deployments for how promote and rollback work.

DomainsCopy Anchor Link

See Custom domains for details.

Environment variablesCopy Anchor Link

See Environment variables for details.

CacheCopy Anchor Link

See Cache invalidation for details.

Usage and billingCopy Anchor Link

Charges shown by ntro usage are estimates in the team's billing currency, not a credit balance. 1 credit = 1 USD; local-currency value uses the operator's published fixed credit price, not live FX. Monthly plan credits cover usage only and do not roll over; operator-granted credits reduce invoice totals across currencies, oldest first. Receipts are sent to the billing customer's email address when positive-total invoices become paid.

See Usage and billing for details.