Configuración

orbiads-cli almacena su configuración en ~/.orbiads/config.json. Todos los parámetros se pueden definir con el comando orbiads config o editando el archivo directamente.

Archivo de configuración

Guardado en su carpeta personal (creado por orbiads auth login)

~/.orbiads/config.json

En Linux y macOS, la carpeta se crea con modo 700 y el archivo con modo 600, porque contiene sus tokens de acceso. No lo suba a un repositorio ni lo comparta nunca.

config.json

{
  "apiUrl": "https://<your-orbiads-backend>",
  "networkCode": "66235823",
  "defaultOutput": "table",
  "token": "<access token, written by orbiads auth login>",
  "refreshToken": "<refresh token, written by orbiads auth login>"
}

Campos de configuración

Campo	Tipo	Descripción	Por defecto
apiUrl	string	URL base del backend de OrbiAds con el que se comunica la CLI.	URL de backend integrada
networkCode	string	Código de red de Google Ad Manager por defecto. Lo definen orbiads auth login y orbiads network switch.	sin definir
defaultOutput	string	Preferencia de formato de salida guardada: table, json o csv. Elija el formato de un comando con --output o --json.	"table"
token	string	Token de acceso escrito por orbiads auth login. Enmascarado por orbiads config show.	definido por el login
refreshToken	string	Token de actualización usado para renovar automáticamente el token de acceso. Enmascarado por orbiads config show.	definido por el login

Leer y modificar los ajustes

Use el comando config en lugar de editar el archivo a mano. Requiere haber ejecutado antes orbiads auth login.

$ orbiads config show

$ orbiads config set --network-code 66235823

$ orbiads config set --default-output json

Variables de entorno

La CLI lee estas variables de entorno. No existe ninguna variable para el token ni para el código de red: use orbiads auth login y orbiads network switch.

Variable	Efecto
ORBIADS_API_URL	Sustituye la URL de backend integrada por defecto (se usa cuando el login crea el archivo de configuración).
ORBIADS_FIREBASE_KEY	Sustituye la clave de API web de Firebase integrada que se usa para renovar los tokens. Pensada para compilaciones de staging o autoalojadas.

Autocompletado del shell

Instale el autocompletado con tabulador para su shell con el comando integrado y reinicie el terminal.

$ orbiads --install-completion

Shells compatibles: Bash, Zsh, Fish y PowerShell. Ejecute orbiads --show-completion para mostrar el script en lugar de instalarlo.

Formatos de salida

Los datos van a stdout y los mensajes a stderr, de modo que la salida se puede redirigir sin problemas. Elija un formato por comando con la opción global --output, o use --json.

--output table

Tabla legible (por defecto en un terminal interactivo).

NAME              STATUS       IMPRESSIONS
My Campaign       DELIVERING   1,234,567
Summer Promo      DRAFT        0

--output json

JSON legible por máquinas, ideal para scripts y agentes de IA. También se usa automáticamente cuando stdout se redirige.

[
  {
    "name": "My Campaign",
    "status": "DELIVERING",
    "impressions": 1234567
  }
]

--output csv

Valores separados por comas para hojas de cálculo y pipelines de datos.

name,status,impressions
My Campaign,DELIVERING,1234567
Summer Promo,DRAFT,0