nuon --help (or nuon <command> --help) for the full set.
Global flags
These work on every command.| Flag | What it does |
|---|---|
--config <path>, -C <path> | Use a custom config file instead of ~/.nuon. Can also be set with the NUON_CONFIG_FILE env var. |
--output <format> | Output format: table (default), json, or agent. Can also be set with NUON_OUTPUT. |
--read-only | Block any command that modifies state. Can also be set with NUON_READ_ONLY=1. |
--debug | Print per-request API timing to stderr. |
Authenticate
| Command | What it does |
|---|---|
nuon auth login | Sign in (browser SSO). Run this first. |
nuon auth logout | Sign out. |
Organizations
| Command | What it does |
|---|---|
nuon orgs select | Switch your active org. A new trial account has a single org that’s selected automatically when you log in, so you only need this once you belong to more than one. |
nuon orgs current | Show the active org. |
nuon orgs api-tokens create --name <name> | Create a durable API token for the current org (shown once). Requires org admin. Add --role (defaults to org_read_only; run nuon roles list or see Access control) to set the token’s permissions, or --personal to issue the token against your own account and its existing roles instead. |
nuon orgs api-tokens list | List the current org’s API tokens. |
nuon orgs api-tokens delete --id <token-id> | Revoke an API token. |
nuon orgs update-user-role --user-id <id> --role <role> | Change an org member’s role (run nuon roles list or see Access control). Requires org admin. |
Apps & config
| Command | What it does |
|---|---|
nuon apps create --name <name> | Create an app in the control plane. |
nuon apps sync | Sync the config in the current directory to Nuon. The app name comes from the directory name. |
nuon apps validate | Validate the config in the current directory. |
nuon apps list | List your apps. |
nuon apps select | Set your active app. |
App branches
These subcommands take the app ID (app...) — get it from nuon apps list. Running nuon apps select with no
flags and picking from the list stores the ID, which lets you omit --app-id from trigger and runs.
| Command | What it does |
|---|---|
nuon sync --branch <name> | Sync the current directory, then trigger a run on that app branch. Add --preview for a plan-only run, or use --app-branch to pick the branch interactively. These flags are on nuon sync, not nuon apps sync. |
nuon apps branches list --app-id <app-id> | List an app’s branches. Alias: nuon apps br. |
nuon apps branches get --app-id <app-id> --branch-id <branch-id> | Show a branch and its deployment groups. |
nuon apps branches create --app-id <app-id> --name <name> | Create a branch without syncing a config file. |
nuon apps branches trigger --branch-id <branch> | Trigger a branch run against the selected app. --preview plans every group but applies nothing, --force rebuilds every component. |
nuon apps branches runs --branch-id <branch> | List the selected app’s branch runs and open one in the workflow TUI. |
nuon apps branches delete --app-id <app-id> --branch-id <branch> --confirm | Delete a branch. |
Installs
| Command | What it does |
|---|---|
nuon installs create | Create an install of the selected app. |
nuon installs list | List installs. Add --labels k=v (repeatable) to filter; all labels must match. |
nuon installs get | Show an install’s details. |
nuon installs labels set --install-id <install> k=v ... | Set labels on an install. Deployment group label selectors match on these. |
nuon installs labels list --install-id <install> | List an install’s labels. |
nuon installs labels unset --install-id <install> <key> ... | Remove labels from an install. |
nuon installs components deploy-all | Deploy all components to an install. |
nuon installs outputs | View an install’s outputs. |
Operate
Help
| Command | What it does |
|---|---|
nuon <command> --help | Help for any command. |
nuon docs | Open the docs. |
nuon completion <shell> | Generate shell autocompletion. |
nuon version | Show the installed CLI version. |