Configuration
The CLI uses a layered configuration system with multiple sources. Higher priority sources override lower ones.
Configuration Priority
Section titled “Configuration Priority”- Environment variables (highest) -
VSB_API_KEY,VSB_BASE_URL - Config file (lowest) -
~/.config/vsb/config.yaml
Interactive Setup
Section titled “Interactive Setup”Run the configuration wizard to set up credentials interactively:
vsb configThis prompts for your API key and gateway URL, then saves them to the config file.
Manual Configuration
Section titled “Manual Configuration”Set Individual Values
Section titled “Set Individual Values”# Set API keyvsb config set api-key "your-api-key"
# Set gateway URLvsb config set base-url "https://your-gateway.vsx.email"View Current Configuration
Section titled “View Current Configuration”vsb config showThe API key is masked in the output for security.
Config File
Section titled “Config File”The config file is stored at ~/.config/vsb/config.yaml:
api_key: your-api-keybase_url: https://your-gateway.vsx.emaildefault_output: prettyConfig File Options
Section titled “Config File Options”| Key | Description | Default |
|---|---|---|
api_key | Your VaultSandbox API key | - |
base_url | Gateway server URL | - |
default_output | Output format (pretty or json) | pretty |
Note: default_output can only be set by editing the config file directly. The vsb config set command only supports api-key and base-url.
Environment Variables
Section titled “Environment Variables”| Variable | Description |
|---|---|
VSB_API_KEY | Your VaultSandbox API key |
VSB_BASE_URL | Gateway URL |
VSB_CONFIG_DIR | Override config directory |
VSB_OUTPUT | Default output format |
Example:
export VSB_API_KEY="your-api-key"export VSB_BASE_URL="https://your-gateway.vsx.email"vsb inbox createGlobal Flags
Section titled “Global Flags”These flags work with any command:
| Flag | Description |
|---|---|
--config | Specify config file path |
-o, --output | Output format: pretty or json |
Example:
vsb inbox list --output jsonData Storage
Section titled “Data Storage”The CLI stores data in ~/.config/vsb/:
| File | Description |
|---|---|
config.yaml | Configuration settings |
keystore.json | Inbox private keys (base64-encoded) |
Next Steps
Section titled “Next Steps”- TUI Dashboard - Launch the interactive dashboard
- Inbox Commands - Create and manage inboxes