Global options

Project

-p, --project <id> runs a single command against another project, ahead of the directory's link. It accepts a project ID or slug. The APIVAULT_PROJECT environment variable does the same for every command in a shell. See project linking for the full order.

apivault --project my-other-app keys list
APIVAULT_PROJECT=my-other-app apivault keys list

JSON output

--json prints machine-readable JSON to stdout instead of styled text, for scripts, pipelines and tools like jq. Success messages and formatting are switched off, and errors are printed to stdout too, as an object with an error key — for example {"error": "message"} — so a script can always parse what it gets back. In the interactive shell on these docs, formatted JSON output has a copy button for copying the payload to your clipboard.

# Extract just the IDs of all keys
apivault --json keys list | jq '.[] | .id'

# Decrypt a specific key and output raw text
apivault --json keys get <id> --reveal | jq -r .rawKey

# Export an environment programmatically
apivault --json env export --env Production

Timeout

--timeout <seconds> sets how long apivault login waits for you to approve the connection in your browser. The default is 300.

apivault --timeout 600 login

Help

-h, --help lists the commands, or the subcommands and options of the command it follows.

apivault --help
apivault keys --help
apivault keys add --help

Version

-V, --version prints the installed version.

apivault --version

Environment variables

Color is also off whenever output is not a terminal, such as when it is piped to another command or written to a file.

Local files

The CLI keeps its own data in ~/.apivault/:

A linked directory also has its own .apivault.json — see the local project file.

Exit codes