CLI configuration
Configure the config.yaml preferences of prb CLI, active host and organization selection, and overlap of environment variables ZEBRABYTE_HOST/ZEBRABYTE_TOKEN.
CLI keeps preferences and hosts authenticated in a user configuration file of the operating system. Use prb config for accepted preferences and prb auth for host credentials.
Inspect and change preferences
Section entitled “Inspect and change preferences”# Show every supported preference and its current valueprb config list
# Read one valueprb config get http_timeout
# Set one valueprb config set http_timeout 60sSupported keys:
| Key | Accepted value | Current behavior |
|---|---|---|
browser |
Browser command or executable | Device authorization opens and prb browse with the selected browser |
http_timeout |
Read more about: | Setting the request timeAPI; by default to 30s when it is disabled or invalid |
prompt |
enabled or disabled |
Saved for compatibility; use --no-interactive or environment settings today |
editor |
Editor command or executable | Saved for compatibility; current commands do not launch an editor |
pager |
Pager command or executable | Saved for compatibility; current commands do not launch a pager |
prb config set valid prompt and http_timeout. unknown keys are rejected.
Configuration file
Section titled “Configuration file”CLI stores config.yaml in the user configuration directory of the platform:
| Platform | Default path |
|---|---|
| macOS | ~/Library/Application Support/prb/config.yaml |
| Linux | ${XDG_CONFIG_HOME:-~/.config}/prb/config.yaml |
| Windows | %AppData%\prb\config.yaml |
The content directory is created with user-only permissions, where the platform supports POSIX modes, and the file is written with the mode 0600.
In addition to preferences, the file contains:
active_host, which selects the default implementation.- One
hostsentry per authenticated deployment. - The access token, the refresh token, the token endpoint and the default organization for each host.
Host and organization selection
Section “Host and organization selection”prb auth login normalizes and stores the selected host, then activates it.
PROBO_HOST, when set.- The stored
active_host. - The first host stored, sorted by name.
Commands that support --org use that flag as an operation-specific overlap.
To change the active host, log in again:
prb auth login --hostname us.probo.comUse prb auth status to see which host is active and which hosts have a default organization.
Environment overrides
Section entitled ‘Environment overrides’| Variable | Effect |
|---|---|
PROBO_HOST |
Select a deployment and override the stored active host |
PROBO_TOKEN |
Replaces the host access token selected for the current process |
PROBO_NO_INTERACTIVE |
Disable calls when set to 1 or true |
CI |
Disable calls when set to 1 or true |
DEBIAN_FRONTEND |
Disable calls when set to noninteractive |
NO_COLOR |
Disable the ANSI color whenever the variable is present |
TERM |
dumb disables the ANSI prompt and color |
When PROBO_HOST names a stored host, the saved default organization still applies. PROBO_TOKEN does not persist and does not update the configuration file.
For a non-state CI job, set both host and token:
PROBO_HOST=https://eu.probo.com \PROBO_TOKEN="$PROBO_CI_TOKEN" \prb framework list --no-interactive --no-color --output jsonWhen only PROBO_TOKEN is set, at least one host must already be configured. Set PROBO_HOST as well as when the load should not depend on the local state.
Diagnose configuration errors
Section entitled “Diagnose configuration errors”| Symptom | Likely cause or action |
|---|---|
not logged in |
Run prb auth login or set both PROBO_HOST and PROBO_TOKEN |
| The token is set, but no host is configured | Set PROBO_HOST or authenticate once to set a host |
| Requests reach the wrong deployment | Check PROBO_HOST and the active host presented by prb auth status |
| Commands target the wrong organization | Step --org or log in again and select the default organization |
| Configuration cannot be parsed | Restore a valid YAML file; keep the file secure before replacement |
| Requests time out too quickly | Increase ___ZBT_I18N_RUNTIME_BLOCK_232__, for example ___ZBT_I18N_RUNTIME_BLOCK_233__ |
Title: CLI Configuration Description: Configuring Behavior and PreferencesZebraByteCLI
The prb config commands manage the CLI configuration settings. They control how prb interacts with the terminal and with external tools.
Configuration keys
Section titled “Configuration keys”| Key | Description |
|---|---|
editor |
Text editor for editing operations |
browser |
Browser for prb browse and other URL opening commands |
pager |
Pager for long outputs (for example less) |
prompt |
Prompt style |
http_timeout |
HTTP request timeout |
Set a value
Section entitled “Set a value”prb config set editor vimGet a value
Posts Tagged ‘Get a Value’prb config get editorList all settings
Section entitled “List all settings”prb config listOther utility commands
Section titled “Other utility commands”Open the platform in your browser.
Section “Open the platform in your browser”prb browse| Flag | Description |
|---|---|
--no-browser, -n |
Print the URL instead of opening the browser |
--org |
Organization ID to open |
Shell completion
Section entitled ‘Shell completion’Generate shell completion scripts for your shell:
prb completion bash # Bashprb completion zsh # Zshprb completion fish # Fishprb completion powershell # PowerShellVersion
Section entitled “Version”prb versionRaw GraphQL queries
Section entitled “RawGraphQLqueries”Run bruteGraphQL queries against the API platform:
prb api 'query { organizations { nodes { id name } } }'With variables:
prb api 'query($id: ID!) { organization(id: $id) { name } }' -f id=org_xxx| Flag | Default | Description |
|---|---|---|
-f |
— | GraphQL variables as pairs ___ZBT_I18N_RUNTIME_BLOCK_264__ (values parse as JSON, back to string) |
--schema |
console |
Endpoint Scheme: console or connect |
Questions can also be piped from stdin:
echo 'query { organizations { nodes { id } } }' | prb api