Scripting
CLI'en er bygget til at blive styret af shell-scripts, CI-jobs og kodeagenter. Data går til stdout, alt andet går til stderr, exit codes er stabile, og hver prompt kan slås fra.
Output
Output er tekst, når stdout er en terminal, og JSON, når den pipes eller omdirigeres; gennemtving et format med --output json eller --output text, variablen POLYLANE_OUTPUT eller konfigurationsfilen, i den rækkefølge. stdout bærer kun data, uanset om det er JSON, tabelrækker eller streamede tokens, så det er sikkert at pipe. stderr bærer spinnere, fremdrift, tips og fejl, og i JSON-tilstand ankommer en fejl som et objekt med code, message og hint, hvor code matcher exit coden.
Flag til scripts
| Flag | Beskrivelse |
|---|---|
--output json | Gennemtving JSON uanset terminaltilstand |
--quiet | Undertryk spinnere og fremdrift; stdout forbliver rene data |
--non-interactive | Fejl hurtigt ved manglende input i stedet for at prompte |
--yes | Spring bekræftelse over på destruktive kommandoer |
--dry-run | Vis hvad der ville ske uden at lave ændringer |
--full | Returnér fulde objekter på list-kommandoer i stedet for den smalle feltprojektion |
--api-key <key> | Tilsidesæt den gemte API-nøgle for ét kald |
--workspace <id> | Tilsidesæt standardarbejdsområdet for ét kald |
Med --non-interactive nægter polylane cloud disconnect at køre, medmindre du også sender --yes med, mens andre bekræftelser, såsom polylane memory delete, springes over, så send --yes med eksplicit for at gøre hensigten klar. POLYLANE_API_KEY og POLYLANE_WORKSPACE_ID sætter legitimationen og arbejdsområdet fra miljøet, hvilket passer til CI; se Autentificering.
Exit codes
| Code | Beskrivelse |
|---|---|
| 0 | Succes |
| 1 | Generel fejl |
| 2 | Brugsfejl: forkert flag, manglende argument |
| 3 | Autentificeringsfejl |
| 4 | Rate limit eller planopgradering påkrævet |
| 5 | Timeout |
| 6 | Netværksfejl |
| 130 | Afbrudt med Ctrl-C |
Forgren på exit coden først for at afgøre, om du skal prøve igen, autentificere igen eller vise fejlen, og parse derefter fejlobjektet på stderr for detaljer.
Eksempel
polylane issue list --active --severity critical --output json --quiet \
| jq -r '.items[] | "\(.id)\t\(.title)"'
polylane issue list returnerer et objekt med items og count, og hvert element projiceres til id, severity, status, title, resourceKind, resourceId, detectedAt og investigationThreadId; --full returnerer de komplette objekter. Issues forklarer livscyklussen bag hver status.
Relateret
- Autentificering: API-nøgler og miljøvariabler til CI.
- Konfiguration: output- og timeout-indstillinger og konfigurationsfilen.
- Issues: de statusser og alvorsgrader,
issue-kommandoerne returnerer. - Tråde: hvad
thread askstarter, og hvordan en tråd skrider frem.