# CLI reference

> Every nodus command, flag and example, generated from the CLI's command tree.

Source: https://nodus-platform-site.pages.dev/docs/reference/cli/
Build revision: 211ad9f836655b1c3a2668c4693e442471f28614

The `nodus` CLI follows kubectl’s verbs (`get`, `describe`, `apply`, `delete`, `logs`, `exec`, `cp`) over every Nodus resource, plus task commands such as `run`, `login` and `billing`. Global flags:

|Flag|Meaning|
|-|-|
|`--context`, `--org`|Select a context or org|
|`-p, --project` (`-n` accepted), `-A, --all-projects`|Project scope|
|`-o, --output`|`table`, `wide`, `json`, `yaml`, `name`, `jsonpath=…`, `custom-columns=…`, `csv`, `estimate`|
|`-l, --selector`, `--field-selector`|Label and field selectors|
|`-w, --watch`|Keep watching after listing|
|`--dry-run=server`|Validate and return the estimate without creating anything|

`nodus run` exits with your command’s exit code. Nodus and API errors exit `125` and timeouts `124`.

## Commands

[nodus ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus/)Run compute Jobs on Nodus

[nodus agentrun ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_agentrun/)Message an AgentRun and read its steps and answer

[nodus agentrun answer ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_agentrun_answer/)Print an AgentRun's last answer in full

[nodus agentrun send ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_agentrun_send/)Send a message to an AgentRun, which takes it as its next prompt

[nodus agentrun steps ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_agentrun_steps/)List an AgentRun's journal steps: what it did, in order

[nodus annotate ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_annotate/)Set or remove annotations

[nodus api-resources ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_api-resources/)List the kinds the server offers

[nodus apply ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_apply/)Create or update resources from manifests (client-side three-way merge)

[nodus attach ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_attach/)Attach to a running Process of a Job, Sandbox or Workspace

[nodus auth ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_auth/)Credentials for other tools, and permission checks

[nodus auth can-i ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_auth_can-i/)Check whether the current credential may perform an action

[nodus auth token ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_auth_token/)Print an ExecCredential for kubectl and client-go (the kubeconfig exec plugin)

[nodus billing ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_billing/)Show the org's balance; top up, redeem a code and manage auto-recharge

[nodus billing auto-recharge ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_billing_auto-recharge/)Top up automatically when available credit falls below a threshold

[nodus billing deal ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_billing_deal/)View partner offers or request an eligibility review

[nodus billing portal ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_billing_portal/)Open the Stripe Customer Portal: cards, invoices and billing details

[nodus billing receipts ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_billing_receipts/)List top-ups with their Stripe receipt links

[nodus billing redeem ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_billing_redeem/)Redeem a promo code for credit

[nodus billing top-up ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_billing_top-up/)Buy prepaid credit with Stripe Checkout ($5–$1,000)

[nodus billing usage ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_billing_usage/)Show metered usage, itemized or summed by project, kind, member, label, meter, day, segment, offering or rank

[nodus cancel ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_cancel/)Cancel a run, FunctionCall or Process

[nodus cloud ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_cloud/)Inspect connected cloud accounts

[nodus cloud inventory ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_cloud_inventory/)List the instances, GPUs or spend a cloud account's last sync saw

[nodus completion ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_completion/)Generate the autocompletion script for the specified shell

[nodus completion bash ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_completion_bash/)Generate the autocompletion script for bash

[nodus completion fish ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_completion_fish/)Generate the autocompletion script for fish

[nodus completion powershell ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_completion_powershell/)Generate the autocompletion script for powershell

[nodus completion zsh ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_completion_zsh/)Generate the autocompletion script for zsh

[nodus config ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_config/)Show and change contexts in \~/.nodus/config

[nodus config current-context ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_config_current-context/)Print the current context

[nodus config get-contexts ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_config_get-contexts/)List contexts

[nodus config set-context ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_config_set-context/)Change a context's project or server (NAME defaults to the current context)

[nodus config use-context ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_config_use-context/)Switch the current context

[nodus config view ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_config_view/)Print the config (keys stay in the keychain)

[nodus convert ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_convert/)Turn a 0.x nodus.toml or training file into manifests for nodus apply

[nodus cp ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_cp/)Copy files to and from a running Sandbox, Workspace or Job, or download a Job output

[nodus create ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_create/)Create resources from manifests or with a typed generator

[nodus create agentgroup ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_create_agentgroup/)Create a agentgroup

[nodus create agentrun ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_create_agentrun/)Create a agentrun

[nodus create apikey ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_create_apikey/)Create an API key (printed once)

[nodus create budget ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_create_budget/)Create a budget

[nodus create enrollmenttoken ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_create_enrollmenttoken/)Create a token that enrolls one host into a Pool (installer printed once)

[nodus create inferenceendpoint ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_create_inferenceendpoint/)Create a inferenceendpoint

[nodus create invite ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_create_invite/)Invite someone to the org by email

[nodus create sandbox ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_create_sandbox/)Create a sandbox

[nodus create secret ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_create_secret/)Create a secret

[nodus create sshkey ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_create_sshkey/)Add an SSH public key, or generate a key pair and add it

[nodus create token ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_create_token/)Mint a ServiceAccount API key (printed once)

[nodus create volume ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_create_volume/)Create a volume

[nodus create workspace ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_create_workspace/)Create a workspace

[nodus delete ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_delete/)Delete resources

[nodus deploy ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_deploy/)Deploy the nodus.App in APP.py as a persistent App

[nodus describe ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_describe/)Show everything about one resource: attempts, placement, checkpoint, cost, conditions and events

[nodus diff ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_diff/)Show what apply would change, from a server dry-run (exit 1 when there are differences)

[nodus edit ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_edit/)Edit a resource in $EDITOR and save it as a merge patch

[nodus events ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_events/)List events in the project, or for one object, and watch for new ones

[nodus exec ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_exec/)Run a command in a running Job, Sandbox or Workspace (recorded as a Process)

[nodus explain ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_explain/)Show the documentation of a kind or one of its fields

[nodus get ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_get/)List or show resources

[nodus get transactions ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_get_transactions/)List postings on the org's wallet with the balance after each

[nodus get usage ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_get_usage/)Show metered usage, itemized or summed by project, kind, member, label, meter, day, segment, offering or rank

[nodus inference ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_inference/)Call hosted models: list them, send a chat completion and read a request's receipt

[nodus inference chat ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_inference_chat/)Send one chat completion and print the answer; the request id and charge go to stderr

[nodus inference models ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_inference_models/)List the models you can call now

[nodus inference receipt ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_inference_receipt/)Show what one inference request was charged (receipts are kept 30 days)

[nodus init ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_init/)Scaffold a manifest or app.py in the current directory

[nodus label ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_label/)Set or remove labels

[nodus login ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_login/)Sign in through the console and store one API key per chosen org

[nodus logout ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_logout/)Revoke the context's CLI key and remove the context

[nodus logs ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_logs/)Print or follow a resource's output

[nodus mcp ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_mcp/)Serve Nodus tools to a local MCP client over stdio

[nodus mcp install ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_mcp_install/)Add the Nodus MCP server to Claude Code, Cursor or Codex

[nodus open ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_open/)Open a resource's console page, or a port of its container, in the browser

[nodus patch ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_patch/)Update fields of a resource with a merge or JSON patch

[nodus pool ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_pool/)Pool utilization, forecasts, recommendations and actions

[nodus pool approve ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_pool_approve/)Approve a proposed PoolAction

[nodus pool forecast ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_pool_forecast/)Show a pool's demand forecast with p50 and p90 bands

[nodus pool pause ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_pool_pause/)Pause every automated action in a pool

[nodus pool recommendations ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_pool_recommendations/)List a pool's recommendations

[nodus pool reject ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_pool_reject/)Reject a proposed PoolAction

[nodus pool resume ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_pool_resume/)Resume every automated action in a pool

[nodus pool revert ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_pool_revert/)Undo an executed PoolAction where the action allows it

[nodus pool utilization ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_pool_utilization/)Show a pool's GPU utilization and device-hour ledger

[nodus port-forward ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_port-forward/)Forward local ports to a Job, Sandbox or Workspace

[nodus request ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_request/)Request an action: restart, refresh-secrets, reload-sinks, verify, resend, start, reimport, approve-burst, drain

[nodus resume ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_resume/)Resume a suspended run

[nodus rollout ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_rollout/)Roll out changes

[nodus rollout restart ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_rollout_restart/)Restart without a spec change (alias of \`request restart\`)

[nodus run ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_run/)Run a command as a Job: estimate, phases, logs and the final cost

[nodus secret ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_secret/)Create Secrets from literals, env files or registry logins

[nodus secret create ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_secret_create/)Create a Secret

[nodus serve ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_serve/)Run the App in APP.py and redeploy it whenever a file changes

[nodus shell ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_shell/)Open an interactive shell in a Sandbox, creating it if it is not there

[nodus ssh ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_ssh/)Connect to a Workspace over SSH

[nodus start ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_start/)Start a stopped Sandbox, Workspace, Function, Agent or InferenceEndpoint

[nodus stop ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_stop/)Stop a Sandbox, Workspace, Function, Agent or InferenceEndpoint

[nodus suspend ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_suspend/)Suspend a Job, Pipeline, Sweep, TrainingJob or AgentRun (checkpointing first)

[nodus top ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_top/)Show GPU, CPU and memory use, the hourly rate and spend of running Jobs

[nodus version ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_version/)Print the client version

[nodus volume ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_volume/)Put, get, list and remove the files of a Volume

[nodus volume clear ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_volume_clear/)Commit an empty revision; the Volume and its history stay

[nodus volume get ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_volume_get/)Download a file or directory from a Volume

[nodus volume ls ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_volume_ls/)List a directory of a Volume

[nodus volume put ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_volume_put/)Add a local file or directory to a Volume as a new revision

[nodus volume rm ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_volume_rm/)Remove a file or directory from a Volume as a new revision

[nodus wait ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_wait/)Wait until a resource meets a condition

[nodus whoami ](https://nodus-platform-site.pages.dev/docs/reference/cli/nodus_whoami/)Show the signed-in principal, org, role, project, scopes and available credit