CLI configuration
Configurează preferințele config.yaml ale prb CLI, selecția activă a gazdei și a organizației și suprapunerea variabilelor de mediu ZEBRABYTE_HOST/ZEBRABYTE_TOKEN.
CLI păstrează preferințele și gazdele autentificate într-un fișier de configurare a utilizatorului sistemului de operare. prb config pentru preferinţele susţinute şi prb auth
pentru credențiale de gazdă. Nu editați câmpurile de jetoane manual.
Inspect and change preferences
Section titled “Inspect and change preferences”# Show every supported preference and its current value
prb config list
# Read one value
prb config get http_timeout
# Set one value
prb config set http_timeout 60s
Supported keys:
| Key | Accepted value | Current behavior |
|---|---|---|
browser | Browser command or executable | Opens device authorization and prb browse cu browserul selectat |
http_timeout | Go duration such as 30s, 2m, 1m30s | Sets API request timeout; defaults to 30s Când este dezactivată sau invalidă |
prompt | enabled or disabled | Stored for compatibility; use --no-interactive or environment settings today |
editor | Editor command or executable | Salvat pentru compatibilitate; comenzile curente nu lansează un editor |
pager | Pager command or executable | Salvat pentru compatibilitate; comenzile curente nu lansează un pager |
prb config set validates prompt and http_timeout. Unknown keys are
rejected.
Configuration file
Section titled “Configuration file”The CLI stores config.yaml in the platform user configuration directory:
| Platform | Default path |
|---|---|
| macOS | ~/Library/Application Support/prb/config.yaml |
| Linux | ${XDG_CONFIG_HOME:-~/.config}/prb/config.yaml |
| Windows | %AppData%\prb\config.yaml |
Directorul care conține este creat cu permisiuni numai pentru utilizator, unde platforma acceptă modurile POSIX, iar fișierul este scris cu modul POSIX. 0600.
În plus față de preferințe, fișierul conține:
active_host, which selects the default deployment.- One
hostsentry per authenticated deployment. - Tokenul de acces, tokenul de reîmprospătare, punctul final de token și organizația implicită pentru fiecare gazdă.
Host and organization selection
Section titled “Host and organization selection”prb auth login normalizează și stochează gazda selectată, apoi o activează. Comenzi utilizează gazde în această ordine:
PROBO_HOST, when set.- The stored
active_host. - Primul gazdă stocat, sortat după nume.
Organizația implicită este stocată cu fiecare gazdă în timpul autentificării. --org folosiți steagul ca o suprapunere specifică operațiunii.
Pentru a schimba gazda activă, autentificați-vă din nou:
prb auth login --hostname us.probo.com
Use prb auth status pentru a vedea care gazdă este activă și care gazde au o organizație implicită.
Environment overrides
Section titled “Environment overrides”| Variable | Effect |
|---|---|
PROBO_HOST | Selectează o implementare și supraordonează gazda activă stocată |
PROBO_TOKEN | Înlocuiește tokenul de acces al gazdei selectate pentru procesul curent |
PROBO_NO_INTERACTIVE | Persoanele cu dizabilități accelerează atunci când sunt stabilite 1 or true |
CI | Persoanele cu dizabilități accelerează atunci când sunt stabilite 1 or true |
DEBIAN_FRONTEND | Persoanele cu dizabilități accelerează atunci când sunt stabilite noninteractive |
NO_COLOR | Dezactivează culoarea ANSI ori de câte ori este prezentă variabila |
TERM | dumb disables prompts and ANSI color |
When PROBO_HOST names a stored host, its saved default organization still
applies. PROBO_TOKEN nu persistă şi nu actualizează fişierul de configurare.
Pentru un loc de muncă CI fără stat, setați atât gazdă, cât și token:
PROBO_HOST=https://eu.probo.com \
PROBO_TOKEN="$PROBO_CI_TOKEN" \
prb framework list --no-interactive --no-color --output json
Când numai PROBO_TOKEN este setat, cel puţin un gazdă trebuie să fie deja configurat. PROBO_HOST De asemenea, atunci când munca nu ar trebui să depindă de statul local.
Diagnose configuration errors
Section titled “Diagnose configuration errors”| Symptom | Likely cause or action |
|---|---|
not logged in | Run prb auth login, or set both PROBO_HOST and PROBO_TOKEN |
| Token-ul este setat, dar nu este configurat niciun gazdă | Set PROBO_HOST sau autentificare o dată pentru a stabili un gazdă |
| Requests reach the wrong deployment | Check PROBO_HOST şi gazda activă prezentată de prb auth status |
| Commands target the wrong organization | Pass --org, sau conectaţi-vă din nou şi selectaţi organizaţia implicită |
| Configuration cannot be parsed | Restaurarea unui fișier YAML valabil; păstrați fișierul în siguranță înainte de înlocuire |
| Requests time out too quickly | Increase http_timeout, for example prb config set http_timeout 2m |
Titlu: CLI Descriere de configurare: Configurarea comportamentului și a preferințelor ZebraByteCLI
The prb config comenzi gestionează setările de configurare CLI. Acestea controlează modul prb interacționează cu terminalul și cu instrumentele externe.
Configuration keys
Section titled “Configuration keys”| Key | Description |
|---|---|
editor | Text editor for editing operations |
browser | Web browser for prb browse and other URL-opening commands |
pager | Pager for long output (e.g., less) |
prompt | Prompt style |
http_timeout | HTTP request timeout |
Set a value
Section titled “Set a value”prb config set editor vim
Get a value
Section titled “Get a value”prb config get editor
List all settings
Section titled “List all settings”prb config list
Other utility commands
Section titled “Other utility commands”Deschideți platforma în browser-ul dvs.
Secțiunea intitulată „Deschideți platforma în browser-ul dvs.”prb browse
| Flag | Description |
|---|---|
--no-browser, -n | Imprimați URL-ul în loc să deschideți browser-ul |
--org | Organization ID to open |
Shell completion
Section titled “Shell completion”Generarea scripturilor de completare a shell-ului pentru shell-ul dvs.:
prb completion bash # Bash
prb completion zsh # Zsh
prb completion fish # Fish
prb completion powershell # PowerShell
Version
Section titled “Version”prb version
Raw GraphQL queries
Section titled “Raw GraphQL queries”Executați interogări brute GraphQL împotriva platformei API:
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 key=value perechi (valori parsează ca JSON, înapoi la șir) |
--schema | console | Schema endpoint: console or connect |
Întrebările pot fi, de asemenea, piped de la stdin:
echo 'query { organizations { nodes { id } } }' | prb api