Aller au contenu

CLI Référence des commandes

Exécuter champrep --help et champrep COMMAND --help pour connaître les options exactes fournies par la version installée. Cette page résume l’arborescence actuelle des commandes publiques.

Option Objectif
--env NAME Remplacer l’environnement Gateway actif pour une seule commande.
-v, --verbose Enregistrer les métadonnées des requêtes et des réponses avec l’en-tête d’autorisation masqué.
--debug Ajouter les corps des requêtes et des réponses à la sortie de diagnostic. À utiliser avec prudence en présence de données sensibles.
--json Générer du JSON lisible par machine lorsque cela est pris en charge.
--no-color Désactiver les couleurs ANSI. Le respecte CLIégalement NO_COLOR.

Placez les indicateurs persistants avant ou après une sous-commande, conformément aux règles acceptées par la version installée. Préférez --json pour l’automatisation.

Commande Objectif
champrep auth login Se connecter via l’autorisation du navigateur.
champrep auth login --no-browser Imprimer une URL d’approbation pour un terminal distant.
champrep auth token Enregistrer une cléAPI à portée limitée dans le trousseau du système d’exploitation.
champrep auth whoami Afficher l’identité et le profil actifs.
champrep auth status Afficher l’identité, le quota en temps réel et le contexte d’audit disponible.
champrep auth list Répertorier les profils enregistrés dans tous les environnements.
champrep auth switch PROFILE Sélectionner un autre profil enregistré pour le même compte.
champrep auth logout Supprimer les informations d’identification locales actuelles et l’état du profil.
Commande Objectif
champrep drive ls [REMOTE_PATH] Répertorier les fichiers d’un dossier.
champrep drive tree [REMOTE_PATH] Afficher une arborescence de dossiers récursive.
champrep drive cp SOURCE DEST Transférer un fichier entre l’ordinateur local et Drive.
champrep drive mv OLD NEW Déplacer ou renommer un élémentDrive.
champrep drive rm REMOTE_PATH Supprimer un fichier ou un dossier.
champrep drive mkdir REMOTE_PATH Créer un dossier.
champrep drive quota Afficher l’espace de stockage utilisé et disponible.

Exemples :

Terminal window
champrep drive ls /
champrep drive tree /projects
champrep drive cp ./report.pdf /reports/report.pdf
champrep drive cp /reports/report.pdf ./report.pdf
champrep drive quota --json
Commande Objectif
champrep mail ls Répertorier les messages d’un dossier de boîte aux lettres.
champrep mail read MESSAGE_ID Imprimer un message.
champrep mail send Envoyer un message à l’aide de drapeaux ou de invites.
champrep mail accounts Répertorier les boîtes aux lettres connectées.
champrep mail threads Répertorier les fils de discussion.
champrep mail domains Répertorier les domaines de messagerie visibles.

Utiliser champrep mail send --help avant de créer un script d’envoi afin que les indicateurs relatifs au destinataire, à l’objet, au corps du message et aux pièces jointes de la version installée soient gérés correctement.

Commande Objectif
champrep chat ls Afficher la liste des salles.
champrep chat read ROOM_ID Lire les messages récents.
champrep chat send ROOM_ID Envoyer un message à la salle.
champrep chat unread Afficher le nombre de messages non lus.
champrep chat create Créer une salle.
Commande Objectif
champrep contacts ls Afficher la liste des contacts.
champrep contacts search QUERY Effectuer une recherche par e-mail ou par nom.
champrep contacts read CONTACT_ID Afficher un contact.
champrep contacts labels Afficher la liste des étiquettes.
champrep contacts add USER_ID Ajouter un utilisateur à vos contacts.
champrep contacts update CONTACT_ID Mettre à jour les métadonnées d’un contact.
champrep contacts rm CONTACT_ID Supprimer un contact.

courses Accepte également le learn alias.

Commande Objectif
champrep courses ls Afficher la liste des cours disponibles.
champrep courses enrolled Répertorier les inscriptions de l’utilisateur actif.
champrep courses read COURSE_ID Afficher un cours.
champrep courses sections COURSE_ID Afficher la liste des sections de cours.
Commande Objectif
champrep notes ls Afficher la liste des notes récentes.
champrep notes create Créer une note.
champrep notes read NOTE_ID Imprimer une note.
champrep notes edit NOTE_ID Mettre à jour le titre et/ou le corps d’une note.
champrep notes rm NOTE_ID Supprimer une note.
Commande Objectif
champrep ai chat [PROMPT] Poser une question ponctuelle ou lancer une session interactive.
champrep ai summarize Résumer un fichier.
champrep ai conversations Afficher la liste des conversations enregistrées.
champrep ai read CONVERSATION_ID Lire une conversation.
champrep ai rm CONVERSATION_ID Supprimer une conversation.
champrep ai usage Afficher l’utilisation actuelle de l’IA.

Vérifier les résultats importants générés par l’IA avant de s’y fier.

Commande Objectif
champrep meet create Créer une salle de réunion.
champrep meet ls Répertorier les réunions.
champrep meet join MEETING_ID Ouvrir une réunion dans le navigateur par défaut.

calendar Accepte également le cal alias.

Commande Objectif
champrep calendar today Afficher les événements du jour.
champrep calendar week Afficher les événements de cette semaine.
champrep calendar create Créer un événement.
champrep calendar rm EVENT_ID Supprimer un événement.

Recherchez tout ce à quoi vos identifiants donnent accès en une seule requête. Les résultats sont regroupés par service, et tout élément ignoré est répertorié avec la raison correspondante.

Commande Objectif
champrep search QUERY Effectuez une recherche sur l’ensemble de vos services.
champrep search services Affichez la liste des services que vous pouvez interroger et indiquez si la recherche IA est disponible.
Option Objectif
-s, --service Limiter à un service (répétable). Permet de réduire le coût de la requête.
--limit Nombre maximal de résultats par service (par défaut 5, max. 20).
--ai Classez les résultats à l’aide de l’IA et obtenez une réponse concise. Utilise vos propres crédits IA.
Terminal window
champrep search "q3 roadmap"
champrep search "invoice 1042" --service invoice --service mail
champrep search "what did we decide about pricing" --ai

Une recherche coûte une unité de limite de débit par service effectivement interrogé ; par conséquent, affiner la recherche avec --service est le moyen le plus économique de garantir la réactivité du système. --ai utilise vos crédits IA mensuels ; sans crédits, la commande renvoie tout de même des résultats normaux et vous explique pourquoi le classement par IA n’a pas pu être effectué.

Commande Objectif
champrep work boards Répertorier vos tableaux.
champrep work board BOARD_ID Afficher un tableau de bord.
champrep work tickets Répertorier les tickets. Filtrer par --board, --status, --search, --mine.
champrep work ticket TICKET Afficher un ticket par identifiant ou par clé (par exemple ENG-7).
champrep work create Créer un ticket (--board, --title, --priority, --type).
Terminal window
champrep work tickets --mine
champrep work create --board 642f... --title "Fix login" --priority high --type bug
Commande Objectif
champrep invoice ls Répertorier les factures. Filtrer par --status.
champrep invoice read INVOICE_ID Afficher une facture.
champrep invoice issue INVOICE_ID Émettre un brouillon (passer du statut « brouillon » à « émis »).
champrep invoice send INVOICE_ID Envoyer une facture par e-mail (--to lorsqu’aucun destinataire n’est enregistré).
champrep invoice rm INVOICE_ID Supprimer un brouillon.

La création et l’envoi de factures utilisent le quota d’envoi de factures de votre forfait ; ils nécessitent donc l’ invoice:send Autorisation sur une cléAPI.

Commande Objectif
champrep forms ls Répertorier vos formulaires.
champrep forms read FORM_ID Afficher un formulaire.
champrep forms responses FORM_ID Répertorier les réponses d’un formulaire.
champrep forms create Créer un formulaire (--title, --description, --publish).
champrep forms publish FORM_ID Publier un brouillon de formulaire.
champrep forms rm FORM_ID Déplacer un formulaire vers la corbeille.

Commande Objectif
champrep charts me Afficher votre poste dans l’organigramme.
champrep charts tree Imprimer l’organigramme au format JSON.
champrep charts search QUERY Rechercher des personnes au sein de l’organisation.
champrep charts profile USER_ID Imprimer le profil d’une personne au format JSON.

Gestion de l’organisation (entreprise). Les lectures utilisent le business:read scope.

Commande Objectif
champrep business info Afficher votre organisation et le rôle que vous y occupez.
champrep business members Répertorier les membres de l’organisation.
champrep business usage Afficher les statistiques d’utilisation de l’organisation.

Commande Objectif
champrep account Afficher votre identité, votre forfait, ainsi que votre limite de débit en temps réel, votre consommation quotidienne et votre utilisation de l’espace de stockage.
Terminal window
champrep account
champrep account --json

Gérer le cpk_... Clés utilisées pour l’accès « headless » et l’accès CI. Ces commandes nécessitent une session de navigateur interactive (exécutez champrep auth login « first », et non auth token). La création ou la rotation d’une clé affiche le secret une seule fois.

Commande Objectif
champrep keys ls Répertorier vos clésAPI.
champrep keys create Créer une clé (--name, répétable --scope, --expires-in-days, --allowed-ip).
champrep keys get KEY_ID Afficher les détails d’une clé.
champrep keys audit KEY_ID Afficher le journal d’audit récent d’une clé.
champrep keys update KEY_ID Modifier le nom, les champs d’application, la liste blanche d’adresses IP ou --active/--inactive.
champrep keys regenerate KEY_ID Remplacer le secret (l’ancien secret cesse de fonctionner).
champrep keys revoke KEY_ID Supprimer une clé.
Terminal window
champrep keys create --name "CI deploy" --scope drive:read --scope drive:write
champrep keys create --name "read-only" --scope '*' --expires-in-days 90

Affichage en lecture seule de votre abonnement. Modifier les formules dans le tableau de bord de facturation.

Commande Objectif
champrep billing subscription Afficher votre abonnement actuel (alias sub).
champrep billing cards Répertorier les moyens de paiement enregistrés.
champrep billing receipts Répertorier les reçus antérieurs.

Gérer les abonnements aux webhooks sortants. Utilise le webhooks:manage scope.

Commande Objectif
champrep webhooks ls Répertoriez vos webhooks.
champrep webhooks events Liste des types d’événements auxquels vous pouvez vous abonner.
champrep webhooks create Créez un webhook (--url, reproductible --event). Le secret de signature s’affiche une seule fois.
champrep webhooks rotate WEBHOOK_ID Effectuez une rotation du secret de signature.
champrep webhooks rm WEBHOOK_ID Supprimer un webhook.

Ces commandes ne nécessitent pas de demande de service, sauf indication contraire dans leur texte d’aide.

Commande Objectif
champrep config get KEY Lire une valeur de configuration.
champrep config set KEY VALUE Définissez une valeur de configuration autorisée.
champrep config list Affichez la configuration actuelle.
champrep config path Affichez le chemin d’accès au fichier de configuration.
champrep config env [NAME] Afficher ou définir l’environnement par défaut.
champrep completion SHELL Générez la complétion pour Bash, Zsh, Fish ou PowerShell.
champrep version Version d’impression, commit, date de compilation et informations d’exécution.

Les jetons ne sont pas stockés dans le fichier de configuration. N’essayez pas d’écrire un jeton d’authentification avec config set.

Code Signification
0 Succès.
1 Échec général ou lié à l’utilisation.
3 L’authentification est requise ou n’est pas valide.
4 Les identifiants ne disposent pas de la portée requise.
5 Une limite en temps réel de la passerelle a été atteinte.
6 Panne réseau.
7 Défaillance de la passerelle ou du service.

Les scripts doivent vérifier le code de sortie et analyser --json sortie lorsqu’elle est disponible. Ne considérez pas les messages d’erreur lisibles par l’utilisateur comme une interface stable.

Chaque réponse de la passerelle indique vos limites actuelles. La effectue de manière transparenteCLI des tentatives de réessai en cas de limite minute courte, en respectant Retry-After. Elle non ne met pas en attente lorsqu’une limite journalière est atteinte ou en cas d’attente supérieure à quelques secondes — elle se termine plutôt avec un code 5 et signale la durée exacte de l’attente, afin que les scripts échouent rapidement. Vérifiez vos compteurs en temps réel à tout moment avec champrep account.