Skip to content
Open console

Configuration

The ZCP CLI uses a YAML configuration file to store credential profiles.

PlatformPath
Linux/macOS~/.config/zcp/config.yaml
Windows%APPDATA%\zcp\config.yaml
CustomSet XDG_CONFIG_HOME environment variable
active_profile: default
profiles:
- name: default
bearer_token: 'your-token-here'
api_url: 'https://api.zcp.zsoftly.ca/api'
region: 'yow-1'
project: 'default-9'
- name: staging
bearer_token: 'staging-token-here'
api_url: 'https://api.staging.zcp.zsoftly.ca/api'
region: 'yul-1'
project: 'default-9'
# Add a new profile interactively
zcp profile add
# List all profiles
zcp profile list
# Switch to a different profile
zcp profile use staging
# Show the active profile
zcp profile show
# Update a profile field
zcp profile update --name default --token new-token
# Delete a profile
zcp profile delete staging

Environment variables override the config file. Useful for CI/CD pipelines:

VariableDescription
ZCP_BEARER_TOKENAuthentication token
ZCP_API_URLAPI base URL
ZCP_PROFILEProfile to use
ZCP_PROJECTDefault project
ZCP_REGIONDefault region
ZCP_CLOUD_PROVIDERDefault cloud provider
ZCP_OUTPUTOutput format (table, json, yaml)
ZCP_DEBUGEnable debug output (true/false)

These flags work on every command:

FlagShortDefaultDescription
--profileConfig profile to use
--output-otableOutput format: table, json, yaml
--api-urlOverride API base URL
--timeout30Request timeout in seconds
--debugfalseEnable debug output to stderr
--no-colorfalseDisable color output
--pagerfalsePipe table output through less
--auto-approve-yfalseSkip confirmation prompts

See also: Installation, Quickstart

Ask the ZCP docs

Type a question and pick an assistant. The assistant opens in a new tab and reads this page and the full ZCP documentation, so its answer comes from our docs.

Example questions

Ask with

Your question goes to the assistant you pick, under its own terms.