Skip to content

CLI

The dreadnode CLI — shared flags, environment variables, and conventions that apply across every subcommand.

The dreadnode CLI (aliased as dn) does two different jobs:

  • bare dn launches the app, resumes a session, or runs a one-shot --print prompt
  • dn <subcommand> talks to the platform control plane and registry

The rest of the reference lists every subcommand group in the sidebar. This page covers the conventions every subcommand inherits.

Every subcommand that hits the Dreadnode platform accepts the same identity and scope flags:

FlagPurpose
--profile <name>use a saved profile from ~/.dreadnode
--server <url>platform API URL
--api-key <key>raw API key (requires --server)
--organization <slug>organization scope
--workspace <slug>workspace scope
--project <slug>project scope

Explicit flags win over environment variables, which win over saved profile defaults. See Authentication for the full precedence rules, validation, and profile model.

The DREADNODE_* vars split into two families.

Platform — read by dn login, every platform subcommand, and SDK scripts:

VariableMeaning
DREADNODE_SERVERplatform API URL
DREADNODE_API_KEYplatform API key
DREADNODE_ORGANIZATIONdefault organization
DREADNODE_WORKSPACEdefault workspace
DREADNODE_PROJECTdefault project

Local runtime — read when launching or connecting to the agent runtime started by dn serve:

VariableMeaning
DREADNODE_RUNTIME_URLclient URL to connect to
DREADNODE_RUNTIME_HOST / DREADNODE_RUNTIME_PORTserver bind address
DREADNODE_RUNTIME_TOKENoptional bearer for the runtime
DREADNODE_RUNTIME_IDsandbox detection

DREADNODE_SERVER_HOST, DREADNODE_SERVER_PORT, and SANDBOX_AUTH_TOKEN stay accepted for one release with a deprecation warning — prefer the DREADNODE_RUNTIME_* names.

The capability, dataset, and model groups accept any of these reference forms:

  • name
  • name@version
  • org/name
  • org/name@version

task resolves the latest visible version; scripts and automation use name@latest.

The four registry groups share a verb vocabulary:

VerbWhat it does
initscaffold a new local artifact directory
inspect / validatecheck a local artifact before publishing
pushpublish one new artifact version
syncbulk-publish a directory of artifacts
infoshow a published artifact’s metadata and versions
pull / downloadfetch a published artifact locally without activating it
installdownload and activate a capability (capabilities only)
publish / unpublishchange cross-organization visibility

--publish on push or sync is the shortcut for uploading and making the artifact public in one step.

  • --server is the platform API URL. The runtime host uses --runtime-server.
  • dn serve starts a local runtime server. dn runtime list inspects hosted runtime records.
  • dn sandbox expects a provider sandbox ID, not an internal database UUID.
  • dn capability install ./path activates a local capability; dn capability pull org/name@ver only downloads it.
  • dn airt run and dn airt run-suite launch attacks; the rest of dn airt reviews assessments, reports, analytics, and findings.