Configuration

orbiads-cli stocke sa configuration dans ~/.orbiads/config.json. Tous les paramètres peuvent être définis via la commande orbiads config ou en éditant le fichier directement.

Fichier de configuration

Stocké dans votre dossier personnel (créé par orbiads auth login)

~/.orbiads/config.json

Sous Linux et macOS, le dossier est créé en mode 700 et le fichier en mode 600, car il contient vos jetons d'accès. Ne le versionnez et ne le partagez jamais.

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>"
}

Champs de configuration

Champ	Type	Description	Défaut
apiUrl	string	URL de base du backend OrbiAds avec lequel la CLI communique.	URL backend intégrée
networkCode	string	Code du réseau Google Ad Manager par défaut. Défini par orbiads auth login et orbiads network switch.	non défini
defaultOutput	string	Préférence de format de sortie enregistrée : table, json ou csv. Choisissez le format d'une commande avec --output ou --json.	"table"
token	string	Jeton d'accès écrit par orbiads auth login. Masqué par orbiads config show.	défini par le login
refreshToken	string	Jeton de rafraîchissement utilisé pour renouveler automatiquement le jeton d'accès. Masqué par orbiads config show.	défini par le login

Lire et modifier les paramètres

Utilisez la commande config plutôt que d'éditer le fichier à la main. Elle nécessite un orbiads auth login préalable.

$ orbiads config show

$ orbiads config set --network-code 66235823

$ orbiads config set --default-output json

Variables d'environnement

La CLI lit ces variables d'environnement. Il n'existe pas de variable pour le jeton ni pour le code réseau : utilisez orbiads auth login et orbiads network switch.

Variable	Effet
ORBIADS_API_URL	Remplace l'URL backend par défaut intégrée (utilisée quand le login crée le fichier de configuration).
ORBIADS_FIREBASE_KEY	Remplace la clé d'API Web Firebase intégrée utilisée pour rafraîchir les jetons. Destinée aux builds de staging ou auto-hébergés.

Autocomplétion du shell

Installez l'autocomplétion par tabulation pour votre shell avec la commande intégrée, puis redémarrez votre terminal.

$ orbiads --install-completion

Shells pris en charge : Bash, Zsh, Fish et PowerShell. Lancez orbiads --show-completion pour afficher le script au lieu de l'installer.

Formats de sortie

Les données vont sur stdout et les messages sur stderr : la sortie peut donc être redirigée sans risque. Choisissez un format par commande avec l'option globale --output, ou utilisez --json.

--output table

Tableau lisible (par défaut dans un terminal interactif).

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

--output json

JSON exploitable par machine, idéal pour les scripts et les agents IA. Utilisé aussi automatiquement quand stdout est redirigé.

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

--output csv

Valeurs séparées par des virgules pour les tableurs et les pipelines de données.

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