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. Utilizați prb config pentru preferințele acceptate și prb auth pentru credențiale gazdă.
Inspect and change preferences
Secțiune intitulată „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 | Se deschide autorizarea dispozitivului și prb browse cu browserul selectat |
http_timeout |
Citește mai multe despre: | Setarea timpului de solicitareAPI; în mod implicit la 30s atunci când este dezactivat sau invalid |
prompt |
enabled sau disabled |
Salvat pentru compatibilitate; utilizați --no-interactive sau setările de mediu astăzi |
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 validă prompt și http_timeout. cheile necunoscute sunt respinse.
Configuration file
Secțiune intitulată „Configuration file”CLI stochează config.yaml în directorul de configurare al utilizatorului platformei:
| Platform | Default path |
|---|---|
| macOS | ~/Library/Application Support/prb/config.yaml |
| Linux | ${XDG_CONFIG_HOME:-~/.config}/prb/config.yaml |
| Windows | %AppData%\prb\config.yaml |
Directorul de conținut este creat cu permisiuni numai pentru utilizator, unde platforma acceptă modurile POSIX, iar fișierul este scris cu modul 0600.
În plus față de preferințe, fișierul conține:
active_host, care selectează implementarea implicită.- 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
Secțiune intitulată „Host and organization selection”prb auth login normalizează și stochează gazda selectată, apoi o activează.
PROBO_HOST, when set.- The stored
active_host. - Primul gazdă stocat, sortat după nume.
Comenzile care acceptă --org folosesc steagul respectiv ca o suprapunere specifică operațiunii.
Pentru a schimba gazda activă, autentificați-vă din nou:
prb auth login --hostname us.probo.comUtilizați prb auth status pentru a vedea care gazdă este activă și care gazde au o organizație implicită.
Environment overrides
Secțiune intitulată „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 |
Dezactivează apelurile atunci când sunt setate la 1 sau true |
CI |
Dezactivează apelurile atunci când este setat la 1 sau true |
DEBIAN_FRONTEND |
Dezactivează apelurile atunci când este setat la noninteractive |
NO_COLOR |
Dezactivează culoarea ANSI ori de câte ori este prezentă variabila |
TERM |
dumb dezactivează prompturile și culoarea ANSI |
Când PROBO_HOST numește un host stocat, organizația implicită salvată se aplică în continuare. 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 jsonAtunci când este setat numai PROBO_TOKEN, cel puțin un host trebuie deja configurat. Setă PROBO_HOST precum și atunci când sarcina nu ar trebui să depindă de starea locală.
Diagnose configuration errors
Secțiune intitulată „Diagnose configuration errors”| Symptom | Likely cause or action |
|---|---|
not logged in |
Rulați prb auth login sau setați atât PROBO_HOST cât și PROBO_TOKEN |
| Token-ul este setat, dar nu este configurat niciun gazdă | Set PROBO_HOST sau autentificare o dată pentru a stabili un host |
| Requests reach the wrong deployment | Verificați PROBO_HOST și gazda activă prezentată de prb auth status |
| Commands target the wrong organization | Pasă --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 | Creșteți ___ZBT_I18N_RUNTIME_BLOCK_232__, de exemplu ___ZBT_I18N_RUNTIME_BLOCK_233__ |
Titlu: CLI Descriere de configurare: Configurarea comportamentului și a preferințelorZebraByteCLI
Comenzile prb config gestionează setările de configurare CLI. Acestea controlează modul în care prb interacționează cu terminalul și cu instrumentele externe.
Configuration keys
Secțiune intitulată „Configuration keys”| Key | Description |
|---|---|
editor |
Text editor for editing operations |
browser |
Browser pentru prb browse și alte comenzi de deschidere a adreselor URL |
pager |
Pager pentru ieșiri lungi (de exemplu, less) |
prompt |
Prompt style |
http_timeout |
HTTP request timeout |
Set a value
Secțiune intitulată „Set a value”prb config set editor vimGet a value
Secțiune intitulată „Get a value”prb config get editorList all settings
Secțiune intitulată „List all settings”prb config listOther utility commands
Secțiune intitulată „Other utility commands”Deschideți platforma în browser-ul dvs.
Secțiune intitulată „Open the platform in your browser”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
Secțiune intitulată „Shell completion”Generarea scripturilor de completare a shell-ului pentru shell-ul dvs.:
prb completion bash # Bashprb completion zsh # Zshprb completion fish # Fishprb completion powershell # PowerShellprb versionRaw GraphQL queries
Secțiune intitulată „Raw GraphQL queries”Executați interogări bruteGraphQLîmpotriva platformeiAPI:
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 |
— | GraphQLvariabile ca perechi ___ZBT_I18N_RUNTIME_BLOCK_264__ (valori parsează ca JSON, înapoi la șir) |
--schema |
console |
Schema punctului final: console sau connect |
Întrebările pot fi, de asemenea, piped de la stdin:
echo 'query { organizations { nodes { id } } }' | prb api