Sari la conținut

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.

View as Markdown

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.

# 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:

KeyAccepted valueCurrent behavior
browserBrowser command or executableOpens device authorization and prb browse cu browserul selectat
http_timeoutGo duration such as 30s, 2m, 1m30sSets API request timeout; defaults to 30s Când este dezactivată sau invalidă
promptenabled or disabledStored for compatibility; use --no-interactive or environment settings today
editorEditor command or executableSalvat pentru compatibilitate; comenzile curente nu lansează un editor
pagerPager command or executableSalvat pentru compatibilitate; comenzile curente nu lansează un pager

prb config set validates prompt and http_timeout. Unknown keys are rejected.

The CLI stores config.yaml in the platform user configuration directory:

PlatformDefault 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 hosts entry per authenticated deployment.
  • Tokenul de acces, tokenul de reîmprospătare, punctul final de token și organizația implicită pentru fiecare gazdă.

prb auth login normalizează și stochează gazda selectată, apoi o activează. Comenzi utilizează gazde în această ordine:

  1. PROBO_HOST, when set.
  2. The stored active_host.
  3. 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ă.

VariableEffect
PROBO_HOSTSelectează o implementare și supraordonează gazda activă stocată
PROBO_TOKENÎnlocuiește tokenul de acces al gazdei selectate pentru procesul curent
PROBO_NO_INTERACTIVEPersoanele cu dizabilități accelerează atunci când sunt stabilite 1 or true
CIPersoanele cu dizabilități accelerează atunci când sunt stabilite 1 or true
DEBIAN_FRONTENDPersoanele cu dizabilități accelerează atunci când sunt stabilite noninteractive
NO_COLORDezactivează culoarea ANSI ori de câte ori este prezentă variabila
TERMdumb 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.

SymptomLikely cause or action
not logged inRun 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 deploymentCheck PROBO_HOST şi gazda activă prezentată de prb auth status
Commands target the wrong organizationPass --org, sau conectaţi-vă din nou şi selectaţi organizaţia implicită
Configuration cannot be parsedRestaurarea unui fișier YAML valabil; păstrați fișierul în siguranță înainte de înlocuire
Requests time out too quicklyIncrease 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.

KeyDescription
editorText editor for editing operations
browserWeb browser for prb browse and other URL-opening commands
pagerPager for long output (e.g., less)
promptPrompt style
http_timeoutHTTP request timeout
prb config set editor vim
prb config get editor
prb config list
prb browse
FlagDescription
--no-browser, -nImprimați URL-ul în loc să deschideți browser-ul
--orgOrganization ID to open

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
prb version

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
FlagDefaultDescription
-fGraphQL variables as key=value perechi (valori parsează ca JSON, înapoi la șir)
--schemaconsoleSchema endpoint: console or connect

Întrebările pot fi, de asemenea, piped de la stdin:

echo 'query { organizations { nodes { id } } }' | prb api

Ultima actualizare: