AI Glot websiteOpen AI Glot
CLIAutomatización y salida de la CLI

Automatización y salida de la CLI

Ejecute la CLI de AI Glot de forma segura en scripts y CI mediante JSON o NDJSON, credenciales de entorno, perfiles, códigos de salida y reintentos limitados.

La CLI imprime tablas legibles en la terminal y JSON cuando la salida se redirige (piping), permitiendo que el mismo comando funcione tanto de forma interactiva como en automatizaciones.

Terminal
aiglot batches list                    # tabla en la terminal
aiglot batches list | jq '.data[0].id' # JSON al redirigir
aiglot batches list --output ndjson    # un objeto por línea
aiglot account --json                  # JSON explícito

Los errores se envían a la salida de error estándar (stderr), al igual que las advertencias que el usuario debe conocer, como una página de resultados truncada. Por lo tanto, la salida estándar (stdout) es segura para redirigirse a otro programa.

Paginación

Los comandos batches list y glossaries list se basan en cursores. Pase el next_cursor de la respuesta anterior mediante el parámetro --cursor, o utilice --all para que la CLI lo gestione automáticamente hasta que has_more sea false (limitado a 200 páginas como medida de seguridad):

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

Con --output ndjson, --all imprime cada fila de cada página a medida que llega. En modo table y json, imprime un único resultado combinado con has_more: false, next_cursor: null y un recuento de pages_fetched en lugar de request_id, ya que no se puede asignar un único ID de solicitud cuando se han ejecutado varias.

Autenticación en CI

Cree una clave de API dedicada con el alcance mínimo necesario y almacénela en el gestor de secretos de su proveedor de CI:

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

La CLI verifica las credenciales en este orden: AIGLOT_API_KEY, el llavero (keychain) del SO y, por último, su archivo de configuración protegido.

Códigos de salida

CódigoSignificado
0Éxito
1Error de API o del servidor
2Comando o argumentos inválidos
3Fallo de autenticación o permisos
4Recurso no encontrado
5Límite de tasa superado (Rate limited)
6Conflicto de estado del recurso

Los scripts deben ramificarse según el código de salida o el error.code estructurado, no basándose en el texto del mensaje de error.

Reintentos

Los reintentos son automáticos, pero solo cuando es seguro realizarlos. El error 429 se reintenta en todos los comandos, respetando el encabezado Retry-After con un retroceso (backoff) limitado. Los errores 408 y 5xx solo se reintentan en solicitudes idempotentes (RFC 9110 §9.2.2), como las lecturas, glossaries replace y glossaries delete.

Los comandos glossaries create, glossaries add, glossaries remove, batches rename y batches archive no se reintentan tras un error 5xx, ya que la escritura podría haberse completado y un segundo intento la aplicaría dos veces. Estos fallos se notifican al script con el código de salida 1: vuelva a leer el recurso y decida si debe intentar la operación de nuevo en lugar de reintentar a ciegas.

Utilice --no-retry cuando el programa que llama gestione la política de reintentos, y --timeout <segundos> (predeterminado: 60) para limitar una única solicitud. Los comandos destructivos nunca esperan indefinidamente una respuesta interactiva: el uso no interactivo debe incluir --force.

Perfiles

Utilice perfiles con nombre para mantener separadas las credenciales de diferentes espacios de trabajo o entornos:

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

Variables de entorno

VariablePropósito
AIGLOT_API_KEYClave de API; anula las credenciales almacenadas
AIGLOT_PROFILENombre del perfil de credenciales
AIGLOT_NO_TUIFuerza la salida legible para máquinas
AIGLOT_NO_KEYCHAINOmite el llavero del sistema operativo
NO_COLOREstándar (no-color.org). Desactiva solo el color; no cambia el formato de salida

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.