Skip to content

CLI Installation

Terminal window
npm install -g pabox
Terminal window
passbox --version
# 0.1.0

PassBox stores configuration in ~/.passbox/:

FilePurpose
~/.passbox/config.jsonServer URL, default vault, default environment
~/.passbox/auth.jsonAccess token, refresh token, encrypted master key (mode 0600)
Terminal window
passbox config set server https://api.passbox.dev
Terminal window
passbox config set defaultVault my-app
Terminal window
passbox config set defaultEnvironment production
Terminal window
passbox config get server
passbox config get defaultVault

Create a .passbox.json in your project root to set per-project defaults:

Terminal window
passbox init

This generates:

{
"vault": "my-app",
"environment": "development"
}

Project config takes precedence over global config. Add .passbox.json to version control so your team shares the same defaults.

If running your own PassBox server:

Terminal window
passbox config set server https://your-passbox-server.com

Or set it per-project in .passbox.json:

{
"vault": "my-app",
"server": "https://your-passbox-server.com"
}
CommandDescription
passbox loginAuthenticate with email + password
passbox logoutClear local session
passbox whoamiShow current user
passbox initCreate project config
passbox vaultManage vaults (list, create, delete)
passbox getRetrieve a secret
passbox setStore a secret
passbox deleteDelete a secret
passbox listList secrets in a vault
passbox historyView secret version history
passbox envPush/pull .env files
passbox environmentManage environments
passbox importImport secrets from files
passbox runRun command with secrets injected
passbox memberManage vault members
passbox tokenManage service tokens
passbox webhookManage webhooks
passbox rotationManage secret rotation
passbox accountAccount management
passbox configView/set CLI config
passbox serveStart MCP server