CLI reference
norcube
Command-line interface for the Norcube platform
Not verified yet
Norcube CLI — manage backups, namespaces, and more across your Norcube services from the terminal.
Usage
norcube <command> [flags]Commands
| Command | Description |
|---|---|
api | Make an authenticated request to a Norcube API |
auth | Check the session, manage CLI sessions and CI tokens, and get access tokens for scripts |
backup | Manage Norcube Backup: data sources, backup jobs, restores, policies, restore tests |
billing | See the organization's billing: status, subscriptions, usage, invoices, spending caps |
config | Inspect the local CLI config and its profiles |
configure | Create or change a profile |
doctor | Check the CLI's configuration, credentials and connectivity |
domainradar | Check domain availability, run bulk checks, monitor brands and generate names |
langsync | Manage LangSync namespaces, terms, languages and translations |
login | Sign in to Norcube via your browser |
logout | Sign out: end the session on Norcube and forget it locally |
org | Manage the active Norcube organization |
upgrade | Update norcube to the latest release |
whoami | Show the signed-in user and active organization |
Global flags
| Flag | Default | Description |
|---|---|---|
--auth-url | Override the auth service base URL, same as --endpoint-url auth=URL (env: NORCUBE_AUTH_URL) | |
--cli-connect-timeout | 10 | Seconds to wait for a connection, 0 for no limit (env: NORCUBE_CONNECT_TIMEOUT) |
--cli-read-timeout | 60 | Seconds to wait for each API response, 0 for no limit (env: NORCUBE_READ_TIMEOUT) |
--debug | Print every HTTP request and response to stderr, with credentials redacted (env: NORCUBE_DEBUG=1) | |
--endpoint-url | Override a service endpoint, service=url (repeatable; services: auth, web_app, snapdb, langsync, domainradar, billing, prompthub) | |
--max-attempts | 3 | Attempts for a request that hit throttling or a transient failure, 1 disables retries (env: NORCUBE_MAX_ATTEMPTS) |
--no-color | Disable color and styling (env: NO_COLOR, CLICOLOR=0) | |
--no-pager | Disable automatic paging of long table output (env: $PAGER controls the pager, default: less) | |
--org | Run this command against a specific organization, id or slug (env: NORCUBE_ORG) | |
-o, --output | table | Output format: table | json | yaml | text (env: NORCUBE_OUTPUT) |
--profile | Use a named profile from the config file (env: NORCUBE_PROFILE) | |
--query | JMESPath expression applied to the result before it is printed, e.g. "[?status=='failed'].jobId" | |
--token-file | Read an access token from this file instead of the profile's credentials (env: NORCUBE_TOKEN holds one directly) | |
--web-app | Override the web app base URL used for browser login (env: NORCUBE_WEB_APP) |