Skripting
CLI-en er bygget for å styres av shell-skript, CI-jobber og kodeagenter. Data går til stdout, alt annet går til stderr, avslutningskoder er stabile, og hver prompt kan slås av.
Utdata
Utdata er tekst når stdout er en terminal og JSON når den pipes eller omdirigeres; tving frem et format med --output json eller --output text, variabelen POLYLANE_OUTPUT eller konfigurasjonsfilen, i den prioriteringsrekkefølgen. stdout bærer bare data, enten JSON, tabellrader eller strømmede tokener, så den er trygg å pipe. stderr bærer spinnere, fremdrift, hint og feil, og i JSON-modus kommer en feil som et objekt med code, message og hint, der code stemmer med avslutningskoden.
Flagg for skript
| Flagg | Beskrivelse |
|---|---|
--output json | Tving frem JSON uavhengig av terminaltilstand |
--quiet | Demp spinnere og fremdrift; stdout forblir rene data |
--non-interactive | Feil raskt ved manglende inndata i stedet for å spørre |
--yes | Hopp over bekreftelse på destruktive kommandoer |
--dry-run | Vis hva som ville skje uten å gjøre endringer |
--full | Returner fulle objekter på list-kommandoer i stedet for den smale feltprojeksjonen |
--api-key <key> | Overstyr den lagrede API-nøkkelen for ett kall |
--workspace <id> | Overstyr standard-workspacet for ett kall |
Med --non-interactive nekter polylane cloud disconnect å kjøre med mindre du også sender --yes, mens andre bekreftelser, som polylane memory delete, hoppes over, så send --yes eksplisitt for å gjøre hensikten tydelig. POLYLANE_API_KEY og POLYLANE_WORKSPACE_ID setter legitimasjonen og workspacet fra miljøet, noe som passer CI; se Autentisering.
Avslutningskoder
| Kode | Beskrivelse |
|---|---|
| 0 | Vellykket |
| 1 | Generell feil |
| 2 | Bruksfeil: ugyldig flagg, manglende argument |
| 3 | Autentiseringsfeil |
| 4 | Ratebegrensning eller planoppgradering kreves |
| 5 | Tidsavbrudd |
| 6 | Nettverksfeil |
| 130 | Avbrutt med Ctrl-C |
Forgren på avslutningskoden først for å avgjøre om du skal prøve igjen, autentisere på nytt eller løfte frem feilen, og parse så feilobjektet 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 projiseres til id, severity, status, title, resourceKind, resourceId, detectedAt og investigationThreadId; --full returnerer de komplette objektene. Issues forklarer livssyklusen bak hver status.
Relatert
- Autentisering: API-nøkler og miljøvariabler for CI.
- Konfigurasjon: innstillinger for utdata og tidsavbrudd, og konfigurasjonsfilen.
- Issues: statusene og alvorlighetsgradene
issue-kommandoene returnerer. - Threads: hva
thread askstarter, og hvordan en tråd utvikler seg.