CLI reference

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 Run compute Jobs on Nodus

nodus agentrun Message an AgentRun and read its steps and answer

nodus agentrun answer Print an AgentRun's last answer in full

nodus agentrun send Send a message to an AgentRun, which takes it as its next prompt

nodus agentrun steps List an AgentRun's journal steps: what it did, in order

nodus annotate Set or remove annotations

nodus api-resources List the kinds the server offers

nodus apply Create or update resources from manifests (client-side three-way merge)

nodus attach Attach to a running Process of a Job, Sandbox or Workspace

nodus auth Credentials for other tools, and permission checks

nodus auth can-i Check whether the current credential may perform an action

nodus auth token Print an ExecCredential for kubectl and client-go (the kubeconfig exec plugin)

nodus billing Show the org's balance; top up, redeem a code and manage auto-recharge

nodus billing auto-recharge Top up automatically when available credit falls below a threshold

nodus billing deal View partner offers or request an eligibility review

nodus billing portal Open the Stripe Customer Portal: cards, invoices and billing details

nodus billing receipts List top-ups with their Stripe receipt links

nodus billing redeem Redeem a promo code for credit

nodus billing top-up Buy prepaid credit with Stripe Checkout ($5–$1,000)

nodus billing usage Show metered usage, itemized or summed by project, kind, member, label, meter, day, segment, offering or rank

nodus cancel Cancel a run, FunctionCall or Process

nodus cloud Inspect connected cloud accounts

nodus cloud inventory List the instances, GPUs or spend a cloud account's last sync saw

nodus completion Generate the autocompletion script for the specified shell

nodus completion bash Generate the autocompletion script for bash

nodus completion fish Generate the autocompletion script for fish

nodus completion powershell Generate the autocompletion script for powershell

nodus completion zsh Generate the autocompletion script for zsh

nodus config Show and change contexts in ~/.nodus/config

nodus config current-context Print the current context

nodus config get-contexts List contexts

nodus config set-context Change a context's project or server (NAME defaults to the current context)

nodus config use-context Switch the current context

nodus config view Print the config (keys stay in the keychain)

nodus convert Turn a 0.x nodus.toml or training file into manifests for nodus apply

nodus cp Copy files to and from a running Sandbox, Workspace or Job, or download a Job output

nodus create Create resources from manifests or with a typed generator

nodus create agentgroup Create a agentgroup

nodus create agentrun Create a agentrun

nodus create apikey Create an API key (printed once)

nodus create budget Create a budget

nodus create enrollmenttoken Create a token that enrolls one host into a Pool (installer printed once)

nodus create inferenceendpoint Create a inferenceendpoint

nodus create invite Invite someone to the org by email

nodus create sandbox Create a sandbox

nodus create secret Create a secret

nodus create sshkey Add an SSH public key, or generate a key pair and add it

nodus create token Mint a ServiceAccount API key (printed once)

nodus create volume Create a volume

nodus create workspace Create a workspace

nodus delete Delete resources

nodus deploy Deploy the nodus.App in APP.py as a persistent App

nodus describe Show everything about one resource: attempts, placement, checkpoint, cost, conditions and events

nodus diff Show what apply would change, from a server dry-run (exit 1 when there are differences)

nodus edit Edit a resource in $EDITOR and save it as a merge patch

nodus events List events in the project, or for one object, and watch for new ones

nodus exec Run a command in a running Job, Sandbox or Workspace (recorded as a Process)

nodus explain Show the documentation of a kind or one of its fields

nodus get List or show resources

nodus get transactions List postings on the org's wallet with the balance after each

nodus get usage Show metered usage, itemized or summed by project, kind, member, label, meter, day, segment, offering or rank

nodus inference Call hosted models: list them, send a chat completion and read a request's receipt

nodus inference chat Send one chat completion and print the answer; the request id and charge go to stderr

nodus inference models List the models you can call now

nodus inference receipt Show what one inference request was charged (receipts are kept 30 days)

nodus init Scaffold a manifest or app.py in the current directory

nodus label Set or remove labels

nodus login Sign in through the console and store one API key per chosen org

nodus logout Revoke the context's CLI key and remove the context

nodus logs Print or follow a resource's output

nodus mcp Serve Nodus tools to a local MCP client over stdio

nodus mcp install Add the Nodus MCP server to Claude Code, Cursor or Codex

nodus open Open a resource's console page, or a port of its container, in the browser

nodus patch Update fields of a resource with a merge or JSON patch

nodus pool Pool utilization, forecasts, recommendations and actions

nodus pool approve Approve a proposed PoolAction

nodus pool forecast Show a pool's demand forecast with p50 and p90 bands

nodus pool pause Pause every automated action in a pool

nodus pool recommendations List a pool's recommendations

nodus pool reject Reject a proposed PoolAction

nodus pool resume Resume every automated action in a pool

nodus pool revert Undo an executed PoolAction where the action allows it

nodus pool utilization Show a pool's GPU utilization and device-hour ledger

nodus port-forward Forward local ports to a Job, Sandbox or Workspace

nodus request Request an action: restart, refresh-secrets, reload-sinks, verify, resend, start, reimport, approve-burst, drain

nodus resume Resume a suspended run

nodus rollout Roll out changes

nodus rollout restart Restart without a spec change (alias of `request restart`)

nodus run Run a command as a Job: estimate, phases, logs and the final cost

nodus secret Create Secrets from literals, env files or registry logins

nodus secret create Create a Secret

nodus serve Run the App in APP.py and redeploy it whenever a file changes

nodus shell Open an interactive shell in a Sandbox, creating it if it is not there

nodus ssh Connect to a Workspace over SSH

nodus start Start a stopped Sandbox, Workspace, Function, Agent or InferenceEndpoint

nodus stop Stop a Sandbox, Workspace, Function, Agent or InferenceEndpoint

nodus suspend Suspend a Job, Pipeline, Sweep, TrainingJob or AgentRun (checkpointing first)

nodus top Show GPU, CPU and memory use, the hourly rate and spend of running Jobs

nodus version Print the client version

nodus volume Put, get, list and remove the files of a Volume

nodus volume clear Commit an empty revision; the Volume and its history stay

nodus volume get Download a file or directory from a Volume

nodus volume ls List a directory of a Volume

nodus volume put Add a local file or directory to a Volume as a new revision

nodus volume rm Remove a file or directory from a Volume as a new revision

nodus wait Wait until a resource meets a condition

nodus whoami Show the signed-in principal, org, role, project, scopes and available credit