Skip to main content

Install the CLI

The CLI needs Node.js 22 or later. Run it without installing:

npx spacecontext --help

or install it globally:

npm install -g spacecontext
spacecontext --version

Sign in​

Create a key in the console (a test key to start), then:

spacecontext login

Paste the key when asked; it is not shown while you type. The CLI checks it with the API and saves it in ~/.config/spacecontext/config.json (or $XDG_CONFIG_HOME/spacecontext/), readable by your user only.

spacecontext whoami      # account, mode and scopes of the saved key
spacecontext logout      # forget it

Where the key comes from​

The CLI uses the first of:

  1. --api-key sc_… on the command line;
  2. the SPACECONTEXT_API_KEY environment variable (handy in CI);
  3. the key saved by login.

--base-url and SPACECONTEXT_BASE_URL point the CLI at another API base. A base URL saved by login --base-url … is used only together with the key saved with it, so a key from the environment never goes to a URL meant for another key.

Output for scripts​

Every command accepts --json and prints the API's JSON on standard output; progress goes to standard error. Exit codes: 0 success, 1 the request failed, 2 wrong usage. Errors print the API's code and request id:

Error [INSUFFICIENT_FUNDS]: The wallet does not cover this scan (request req_…)
Top up your wallet in the console: https://spacecontext.finikos.it/developers/console

Next: the commands.