AI Glot websiteOpen AI Glot
CLIAutomazione e output della CLI

Automazione e output della CLI

Esegui in sicurezza la CLI di AI Glot in script e CI utilizzando JSON o NDJSON, credenziali d'ambiente, profili, codici di uscita e tentativi di ripristino limitati.

La CLI stampa tabelle leggibili nel terminale e JSON quando l’output viene inoltrato tramite pipe, così lo stesso comando funziona sia in modalità interattiva che in automazione.

Terminal
aiglot batches list                    # tabella nel terminale
aiglot batches list | jq '.data[0].id' # JSON quando inoltrato via pipe
aiglot batches list --output ndjson    # un oggetto per riga
aiglot account --json                  # JSON esplicito

Gli errori vengono inviati allo standard error, così come gli avvisi che l’utente deve comunque visualizzare, come ad esempio una pagina di risultati troncata. Di conseguenza, lo standard output rimane sicuro per essere inoltrato a un altro programma.

Impaginazione

batches list e glossaries list utilizzano un sistema basato su cursori. Passa il next_cursor della risposta precedente esattamente così come ricevuto tramite --cursor, oppure usa --all per seguire automaticamente l’impaginazione finché has_more non diventa false (con un limite di sicurezza a 200 pagine):

Terminal
aiglot batches list --status completed --all
aiglot glossaries list --all --output ndjson

In modalità --output ndjson, --all stampa ogni riga di ogni pagina man mano che arriva. In modalità table e json, stampa un unico risultato combinato con has_more: false, next_cursor: null e un conteggio pages_fetched al posto di request_id, poiché non è possibile assegnare un singolo ID di richiesta a più chiamate eseguite.

Autenticazione in CI

Crea una chiave API dedicata con i permessi minimi necessari e memorizzala nel gestore dei segreti del tuo provider di CI:

Terminal
export AIGLOT_API_KEY="aig_live_…"
aiglot account --json

La CLI verifica le credenziali in questo ordine: AIGLOT_API_KEY, keychain del sistema operativo e infine il file di configurazione protetto.

Codici di uscita

CodiceSignificato
0Successo
1Errore API o del server
2Comando o argomenti non validi
3Errore di autenticazione o permessi
4Risorsa non trovata
5Limite di frequenza superato (Rate limited)
6Conflitto di stato della risorsa

Gli script dovrebbero basarsi sul codice di uscita o sul codice strutturato error.code, non sul testo del messaggio di errore.

Tentativi di ripristino (Retries)

I tentativi di ripristino sono automatici, ma solo quando è sicuro farlo. L’errore 429 viene riprovato per ogni comando, rispettando l’intestazione Retry-After con un backoff limitato. Gli errori 408 e 5xx vengono riprovati solo per le richieste idempotenti (RFC 9110 §9.2.2), come le letture, glossaries replace e glossaries delete.

I comandi glossaries create, glossaries add, glossaries remove, batches rename e batches archive non vengono riprovati dopo un errore 5xx, poiché l’operazione di scrittura potrebbe essere già andata a buon fine e un secondo tentativo potrebbe applicarla due volte. Tali errori vengono restituiti allo script con il codice di uscita 1: in questo caso, verifica nuovamente la risorsa e decidi autonomamente se riprovare invece di procedere a un tentativo cieco.

Usa --no-retry quando la politica di ripristino è gestita dal chiamante, e --timeout <secondi> (default 60) per limitare la durata di una singola richiesta. I comandi distruttivi non attendono mai all’infinito un prompt interattivo: per l’uso non interattivo è necessario passare --force.

Profili

Usa i profili nominati per mantenere separate le credenziali di diversi workspace o ambienti:

Terminal
aiglot --profile client-a auth login --key "$CLIENT_A_KEY"
aiglot --profile client-a account
export AIGLOT_PROFILE=client-a

Variabili d’ambiente

VariabileScopo
AIGLOT_API_KEYChiave API; sovrascrive le credenziali memorizzate
AIGLOT_PROFILENome del profilo delle credenziali
AIGLOT_NO_TUIForza l’output leggibile da macchina
AIGLOT_NO_KEYCHAINSalta il keychain del sistema operativo
NO_COLORStandard (no-color.org). Disabilita solo i colori; non modifica il formato dell’output

Use these docs with your AI tools

An AI agent can read this documentation directly. You do not need an account or an API key. Everything here is public and read-only.

Query these docs via MCP

Recommended

Add this server to Claude, Claude Code, Cursor, Mistral, or any tool that supports MCP. Your agent can then search AI Glot Docs documentation and read it in full, instead of answering from memory.

https://ai-glot.com/docs/mcp
  • searchFind the passages that answer a question.
  • fetchRead one page in full, as Markdown.
  • list_pagesSee every page in this documentation.

Query these docs over HTTP

The same tools also work as plain web requests. Use this for scripts, or for any tool that does not support MCP. There is one endpoint per tool. Arguments go in the query string, and the answer comes back as JSON.

https://ai-glot.com/docs/api/docs/search?query=custom+domain

Read the OpenAPI description. It is built from the same definitions as the tools, so it always matches what the endpoints do.

Read these docs as Markdown

Add .md to any page URL to get its Markdown source. You can also send the headerAccept: text/markdown to the page URL itself.

To read the whole documentation in one file, open llms-full.txt. For a short index of every page, open llms.txt.