Configure the Octopoda CLI: sign-in file and environment

The Octopoda CLI has no configuration file to edit. It stores your sign-in after octopoda login, and reads a few environment variables that change where it looks for that sign-in. octopoda login saves the sign-in to credentials.json in the CLI’s configuration folder, readable only by your user:

System	Folder
macOS	`~/Library/Application Support/octopoda`
Linux	`~/.config/octopoda` (or `$XDG_CONFIG_HOME/octopoda`)

octopoda logout deletes it. Treat it like a password: anyone with the token can use Octopoda as you until you sign the device out in Settings → CLI sessions.

Environment variables

Variable	Description
`OCTOPODA_TOKEN`	A sign-in token to use instead of the saved sign-in. Use it in CI. See Run Octopoda scans in CI.
`OCTOPODA_CONFIG_DIR`	A folder to keep `credentials.json` in instead of the default.

The installer reads OCTOPODA_INSTALL_DIR and OCTOPODA_VERSION. See Install and update the CLI.

Exit codes

Code	Meaning
`0`	Success.
`1`	The command failed, a scan failed, or `octopoda scan --fail-on` matched a finding.
`2`	The command line was not valid, such as an unknown command or flag.

​Where your sign-in is stored

​Environment variables

​Exit codes

Where your sign-in is stored

Environment variables

Exit codes