CLI reference

norcube commands

List every command, its flags and behaviour, for people, scripts and agents

Not verified yet

Prints the CLI's whole command tree without signing in or using the network. A table lists each command with its summary; -o json or -o yaml prints a versioned document with everything the help pages say plus what a script or AI agent needs to plan a call: flags with types, defaults and allowed values, whether the command changes anything (effect), asks for confirmation (--yes), can wait for a job (--wait) or pages (--cursor), and which service and OAuth audience it uses.

Give a command path to narrow the tree to it and the commands below it. Hidden commands and old names of renamed commands are left out unless --all is given. The document's schemaVersion only changes for a breaking change; within a version, fields and commands are only ever added.

Usage

norcube commands [command path] [flags]

Examples

norcube commands
norcube commands backup
norcube commands -o json
norcube commands backup jobs -o json --query "commands[?effect=='write'].command"
norcube commands -o json --query 'commands[?confirm].command'

Flags

FlagDefaultDescription
--allInclude hidden commands and the old names of renamed commands

Every command also takes the global flags: --profile, --org, -o, --query, --debug and more.

See also

  • norcube: Command-line interface for the Norcube platform

On this page