Aller au contenu

Référence de la CLI

L’interface en ligne de commande d’opencodex est ocx. La première commande détermine l’opération à exécuter. Les alias documentés, tels que setup/init, restore/eject et models/model, déclenchent la même opération. Une commande inconnue ou une syntaxe de commande non valide produit une erreur.

Exécutez ocx help (ou ocx --help / ocx -h) pour afficher l’aide générale. Pour une commande enregistrée dans la table d’aide, exécutez ocx help <command>, ocx <command> --help ou ocx <command> -h. Les commandes d’aide et de version sont en lecture seule : elles ne démarrent, n’arrêtent, n’installent, ne désinstallent ni ne réécrivent l’état de Codex ou d’opencodex.

  • Cycle de vie — configuration initiale, cycle de vie du proxy et du service, état de santé, diagnostics, synchronisation du catalogue, tableau de bord et mises à jour.
  • Fournisseurs, comptes et modèles — configuration des fournisseurs, authentification, pools d’identifiants, quotas, modèles personnalisés, visibilité, modèles sélectionnés et limites de contexte.
  • Agents, routage et intégrations — contrôles multi-agents, combinaisons, observabilité, clés d’admission, intégrations clientes, paramètres d’exécution, configuration validée et inspection en lecture seule des mises à jour de la CLI Codex.

Les commandes de gestion communiquent avec l’API de gestion du proxy actif. Elles s’appuient sur le port d’exécution enregistré et sur des contrôles d’identité, plutôt que sur un second chemin de configuration. Un proxy arrêté ou inaccessible est représenté par une réponse HTTP 503 et entraîne un code de sortie CLI non nul. Les commandes explicitement documentées comme des opérations de configuration hors ligne peuvent, quant à elles, valider et modifier le fichier de configuration sans proxy actif.

check ne consulte aucun registre et n’exécute pas Codex. Sur POSIX, selectionAttested peut être true si le résolveur choisit le même chemin canonique que le candidat d’environnement capturé par le lanceur publié. Un manifeste npm-global lié peut alors établir managed: true s’il prouve la propriété et, lorsqu’une version candidate est signalée, si elle correspond à celle du manifeste ; les candidats persistants restent non attestés. Windows x64 prend aussi en charge un codex.cmd npm standard absolu lié à la preuve, avec une chaîne d’outils Node/npm liée par les handles — locale au préfixe quand elle est présente, sinon la paire PATH capturée ancrée à l’architecture du lanceur — et une plateforme de support vérifiée dans le préfixe, en utilisant des handles maintenus qui refusent la réanalyse. Les autres dispositions Windows restent différées ou non gérées. Un résultat managed Windows ne décrit que la disposition d’installation observée : le Node/npm lié est la chaîne d’outils de métadonnées en lecture seule de l’outil de mise à jour, et non une garantie sur l’interpréteur qu’une invocation ultérieure de codex.cmd résoudra. Une exécution directe via Bun ou les sources n’a pas de preuve du lanceur. plan consulte le registre officiel avec une configuration, un cache et des journaux npm temporaires isolés, et refuse les sessions actives ou une observation incomplète des processus. Il n’installe rien et n’envoie aucun signal. Sur Windows x64, apply exige un préfixe npm borné doté d’une autorité d’écriture privée vérifiée et préserve les packages et shims non liés ; les dispositions observées non prises en charge renvoient applicable: false et refusal: windows_apply_disabled ; la sélection par PATH seul, les wrappers de démarrage automatique OpenCodex et les replis global/vendor restent différés. Voir les commandes et motifs de refus complets (en anglais).

Pour observer une installation Windows x64, consultez attest. Sans chemins explicites, la commande observe le candidat sélectionné identifié par l’instantané du lanceur lié à la preuve ; aucune autorité de mise à jour ni sélection du runtime n’est attestée.

L’affichage d’une liste ou d’un état est l’action par défaut lorsqu’il n’y a aucune ambiguïté. Utilisez --json pour obtenir des instantanés structurés et ocx observe logs --follow --jsonl pour suivre un flux de journaux de requêtes. Le thème, la langue, la navigation et les autres états purement visuels du navigateur n’ont pas d’équivalent dans la CLI. La configuration de Cloudflare Tunnel ne fait pas partie de cet ensemble de commandes.

ocx health, ocx status, ocx account *, ocx login codex et ocx ready trouvent le proxy en cours d’exécution grâce à une courte sonde : 750 ms par tentative par défaut, 1500 ms avec nouvelles tentatives pour les décisions d’arrêt et de démarrage. Si une couche de sécurité (filtre de contenu, extension réseau de type EDR) ajoute un coût fixe à chaque connexion loopback, ces plafonds peuvent expirer avant qu’un proxy sain réponde.

Définissez OCX_PROBE_TIMEOUT_MS pour relever les plafonds, par exemple OCX_PROBE_TIMEOUT_MS=5000 ocx status. La valeur est un nombre entier de millisecondes entre 1 et 30000. Elle ne peut que relever : le défaut de 750 ms et les budgets d’arrêt/démarrage de 1500 ms gardent leur plancher, donc 1000 n’allonge que la sonde par défaut. Une valeur absente, vide, fractionnaire, négative, nulle ou supérieure est ignorée.

Une commande réussie renvoie le code 0. Une syntaxe non valide, une commande ou une ressource inconnue, l’échec d’une opération d’API ou l’indisponibilité d’un service requis produit un code non nul. Plus précisément, ocx health renvoie 0 uniquement lorsque le proxy est sain, 1 si aucun proxy sain n’est trouvé et 2 si les arguments sont invalides ; cette commande peut donc servir de sonde de service. Les scripts doivent tester le code de sortie plutôt que d’analyser le texte destiné aux utilisateurs.

Les opérations de suppression destructive, d’importation, de consommation de crédits et de mise à jour qui annoncent une confirmation exigent --yes en mode non interactif. Ce drapeau constitue un consentement explicite : son absence ne doit jamais confirmer silencieusement l’opération.

ocx --version, ocx -v et ocx version affichent une seule ligne de version exploitable par un script, puis se terminent.

Deux cibles de répartition sont volontairement absentes de l’aide habituelle : __refresh-version [preview] actualise le cache des notifications de mise à jour dans un processus détaché, tandis que __gui-update-worker <job-id> [latest|preview] [restart] exécute une tâche de mise à jour du tableau de bord. Il s’agit de détails d’implémentation, et non de commandes publiques stables. Le tableau de bord enregistre le PID du processus de travail, récupère une tâche active dont le processus est mort, considère comme obsolètes après dix minutes les anciens enregistrements actifs sans PID et protège un processus vivant contre les mises à jour concurrentes.