Aller au contenu
Documentation

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.

OptionObjectif
--env NAMERemplacer l’environnement Gateway actif pour une seule commande.
--profile IDUtiliser un autre compte enregistré pour une commande sans modifier le compte actif.
-v, --verboseEnregistrer les métadonnées des requêtes et des réponses avec l’en-tête d’autorisation masqué.
--debugAjouter les corps des requêtes et des réponses à la sortie de diagnostic. À utiliser avec prudence en présence de données sensibles.
--jsonGénérer du JSON lisible par machine lorsque cela est pris en charge.
--no-colorDé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.

CommandeObjectif
champrep auth loginSe connecter via l’autorisation du navigateur.
champrep auth login --no-browserImprimer une URL d’approbation pour un terminal distant.
champrep auth tokenEnregistrer une cléAPI à portée limitée dans le trousseau du système d’exploitation.
champrep auth whoamiAfficher l’identité et le profil actifs.
champrep auth statusAfficher l’identité, le quota en temps réel et le contexte d’audit disponible.
champrep auth listRépertorier les profils enregistrés dans tous les environnements.
champrep auth switch PROFILESélectionner un autre profil enregistré pour le même compte.
champrep auth logoutSupprimer les informations d’identification locales actuelles et l’état du profil.
CommandeObjectif
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 DESTTransférer un fichier entre l’ordinateur local et Drive.
champrep drive mv OLD NEWDéplacer ou renommer un élémentDrive.
champrep drive rm REMOTE_PATHSupprimer un fichier ou un dossier.
champrep drive mkdir REMOTE_PATHCréer un dossier.
champrep drive quotaAfficher l’espace de stockage utilisé et disponible.

Exemples :

Fenêtre de terminal
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
CommandeObjectif
champrep mail lsRépertorier les messages d’un dossier de boîte aux lettres.
champrep mail read MESSAGE_IDImprimer un message.
champrep mail sendEnvoyez un message. --subject est obligatoire ; pour envoyer sans ce fichier, omettez-le et passez --no-subject.
champrep mail accountsRépertorier les boîtes aux lettres connectées.
champrep mail threadsRépertorier les fils de discussion.
champrep mail domainsRé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.

CommandeObjectif
champrep chat lsAfficher la liste des salles.
champrep chat read ROOM_IDLire les messages récents.
champrep chat send ROOM_IDEnvoyer un message à la salle.
champrep chat unreadAfficher le nombre de messages non lus.
champrep chat createCréer une salle.
CommandeObjectif
champrep contacts lsAfficher la liste des contacts.
champrep contacts search QUERYEffectuer une recherche par e-mail ou par nom.
champrep contacts read CONTACT_IDAfficher un contact.
champrep contacts labelsAfficher la liste des étiquettes.
champrep contacts add USER_IDAjouter un utilisateur à vos contacts.
champrep contacts update CONTACT_IDMettre à jour les métadonnées d’un contact.
champrep contacts rm CONTACT_IDSupprimer un contact.

courses Accepte également le learn alias.

CommandeObjectif
champrep courses lsAfficher la liste des cours disponibles.
champrep courses enrolledRépertorier les inscriptions de l’utilisateur actif.
champrep courses read COURSE_IDAfficher un cours.
champrep courses sections COURSE_IDAfficher la liste des sections de cours.
CommandeObjectif
champrep notes lsAfficher la liste des notes récentes.
champrep notes createCréer une note.
champrep notes read NOTE_IDImprimer une note.
champrep notes edit NOTE_IDMettre à jour le titre et/ou le corps d’une note.
champrep notes rm NOTE_IDDéplacez une note vers la Corbeille. Récupérez-la dans CHAMPREP Notes dans un délai de 30 jours ; passé ce délai, elle sera automatiquement supprimée. Une note placée dans la Corbeille peut être lue mais ne peut pas être modifiée.
CommandeObjectif
eve ou champrep aiLancez l’agent d’IA interactif de programmation en binôme Eve dans le répertoire courant.
champrep eveAlias pour champrep ai / eve.
eve -p PROMPT ou champrep ai -p PROMPTExécutez l’agent en mode sans interface pour une invite et affichez la réponse.
champrep ai models lsRépertorier les modèles de la plateforme et les modèles que vous avez enregistrés avec votre propre clé.
champrep ai models registerEnregistrez un modèle utilisant votre propre cléAPI de fournisseur.
champrep ai models rm NAMESupprimer un modèle enregistré et sa clé.
champrep ai pathsAfficher tous les fichiers et dossiers locaux utilisés par l’agent.
champrep ai chat [PROMPT]Poser une question ponctuelle ou lancer une session interactive.
champrep ai summarizeRésumer un fichier.
champrep ai conversationsAfficher la liste des conversations enregistrées.
champrep ai read CONVERSATION_IDLire une conversation.
champrep ai rm CONVERSATION_IDSupprimer une conversation.
champrep ai usageAfficher l’utilisation actuelle de l’IA.

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

Pour les commandes « / », les autorisations et les options de l’agent, consultez Agent IA : Eve (champrep ai / eve).

CommandeObjectif
champrep meet createCréer une salle de réunion.
champrep meet lsRépertorier les réunions.
champrep meet join MEETING_IDOuvrir une réunion dans le navigateur par défaut.

calendar Accepte également le cal alias.

CommandeObjectif
champrep calendar todayAfficher les événements du jour.
champrep calendar weekAfficher les événements de cette semaine.
champrep calendar createCréer un événement.
champrep calendar rm EVENT_IDSupprimer 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.

CommandeObjectif
champrep search QUERYEffectuez une recherche sur l’ensemble de vos services.
champrep search servicesAffichez la liste des services que vous pouvez interroger et indiquez si la recherche IA est disponible.
OptionObjectif
-s, --serviceLimiter à un service (répétable). Permet de réduire le coût de la requête.
--limitNombre maximal de résultats par service (par défaut 5, max. 20).
--aiClassez les résultats à l’aide de l’IA et obtenez une réponse concise. Utilise vos propres crédits IA.
Fenêtre de terminal
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é.

CommandeObjectif
champrep work boardsRépertorier vos tableaux.
champrep work board BOARD_IDAfficher un tableau de bord.
champrep work ticketsListe des tickets. Filtrer par --board, --status (un identifiant de statut, ou avec --board un nom de statut), --search, --mine; --limit 1 à 200.
champrep work ticket TICKETAfficher un ticket par identifiant ou par clé (par exemple ENG-7).
champrep work createCréer un ticket (--board, --title, --priority, --type).
Fenêtre de terminal
champrep work tickets --mine
champrep work create --board 642f... --title "Fix login" --priority high --type bug
CommandeObjectif
champrep invoice lsRépertorier les factures. Filtrer par --status.
champrep invoice read INVOICE_IDAfficher une facture.
champrep invoice issue INVOICE_IDÉmettre un brouillon (passer du statut « brouillon » à « émis »).
champrep invoice send INVOICE_IDEnvoyer une facture par e-mail (--to lorsqu’aucun destinataire n’est enregistré).
champrep invoice rm INVOICE_IDSupprimer 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.

CommandeObjectif
champrep forms lsRépertorier vos formulaires.
champrep forms read FORM_IDAfficher un formulaire.
champrep forms responses FORM_IDRépertorier les réponses d’un formulaire.
champrep forms createCréer un formulaire (--title, --description, --publish).
champrep forms publish FORM_IDPublier un brouillon de formulaire.
champrep forms rm FORM_IDDéplacer un formulaire vers la corbeille.

CommandeObjectif
champrep charts meAfficher votre poste dans l’organigramme.
champrep charts treeImprimer l’organigramme au format JSON.
champrep charts search QUERYRechercher des personnes au sein de l’organisation.
champrep charts profile USER_IDImprimer le profil d’une personne au format JSON.

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

CommandeObjectif
champrep business infoAfficher votre organisation et le rôle que vous y occupez.
champrep business membersRépertorier les membres de l’organisation.
champrep business usageAfficher les statistiques d’utilisation de l’organisation.

Projets, branches, demandes de fusion, tickets, pipelines, journaux de tâches et versions. PROJECT est le chemin d’accès complet du projet (acme/web) ou son identifiant. Référence complète : CHAMPREP Commandes de code.

CommandeObjectif
champrep code projects ls / show / createRépertorier, afficher et créer des projets.
champrep code repo clone-url PROJECTAfficher l’adresse du clone (--ssh (pour SSH).
champrep code cloneClonez des projets, un groupe (--group, --include-subgroups) ou entièrement le vôtre (--membership, --owned, --all) dans une arborescence d’espaces de noms ; --update permet de le maintenir à jour.
champrep code branches ls PROJECTRépertorier les branches.
champrep code mr ls / show / create / merge / approveWork avec les demandes de fusion.
champrep code issues ls / show / create / close / reopenWork présentant des problèmes.
champrep code pipelines ls / show / run / retry / cancelWork avec les pipelines.
champrep code pipelines wait PROJECT [ID]Attendez un pipeline, le plus récent d’un commit (--sha), ou la dernière version disponible sur --ref pour terminer ; quitte 0 En cas de réussite, 1 Sinon, 8 sur --timeout.
champrep code jobs ls / log / play / retryRépertorier les tâches, les imprimer ou les suivre (--follow) un journal, lancer des tâches manuelles.
champrep code releases ls PROJECTRépertorier les versions.
champrep code runners ls / show / update / createRépertoriez les runners et les utilisateurs en ligne, modifiez les balises, mettez en pause et reprenez l’exécution, créez un runner.
champrep code ssh-keys lsRépertoriez vos clés SSH pour git via SSH.
Fenêtre de terminal
champrep code clone --group acme --include-subgroups --dest ~/src --ssh
champrep code mr ls acme/web
champrep code pipelines run acme/web --ref main --yes
champrep code jobs log acme/web 4182 --follow

Les recettes détaillées pour Code, Runner Farm et QA, y compris l’utilisation de l’intégration continue (CI), se trouvent dans Tâches courantes.

runner-farm accepte également le rf alias. --workspace sélectionne le compte de la ferme (personal, organization:<id>, team:<id>). Référence complète : Commandes de la ferme de runners.

CommandeObjectif
champrep rf accounts ls / showRépertorier les comptes de la ferme sur lesquels vous pouvez effectuer des opérations ; en afficher un.
champrep rf connections lsRépertorier les connexions aux hôtes de code.
champrep rf pools ls / show / create / updateGérer les pools de runners, y compris --pause et --resume.
champrep rf usageCrédits et minutes pour la période en cours.
champrep rf jobs lsRépertorier les tâches, y compris celles en attente et celles mises en attente.
Fenêtre de terminal
champrep rf pools ls
champrep rf usage

Référentiels, analyses, résultats, contrôles de qualité, aperçus et espaces de travail IDE. REPO est une clé de référentiel telle que code:<project-uuid>. Référence complète : CHAMPREP QA commandes.

CommandeObjectif
champrep qa repos ls / available / activate / deactivate / syncGérer les analyses d’assurance qualité des référentiels.
champrep qa scan REPOLancer une analyse ; --watch La suit jusqu’à la fin.
champrep qa scans ls / showRépertorier et afficher les analyses.
champrep qa findings ls / show / dismiss / reopenFiltre (--severity, --cwe, --branch, --state) et trier les résultats.
champrep qa gates status REPOAffiche le résultat du contrôle de qualité ; quitte 1 en cas d’échec.
champrep qa previews ls / show / create / extend / stopGérer les environnements de prévisualisation.
champrep qa ide ls / start / open / stopGérer les espaces de travail de l’IDE cloud.
Fenêtre de terminal
champrep qa scan code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --watch --yes
champrep qa findings ls --severity critical,high

Dans ces trois familles, les commandes qui modifient quelque chose ou utilisent des minutes d’intégration continue (CI), des crédits ou un quota demandent d’abord : code mr create, mr merge, mr approve, issues close et reopen, chaque action de pipeline et de tâche, rf pools create et update, et à chaque qa écriture (repos activate et deactivate, scan, findings dismiss et reopen, previews create, extend et stop, ide start et stop). Passez --yes (-y) dans les scripts ; sans terminal et sans --yes, elles ne modifient rien. La création d’un projet ou d’un ticket Code ne vous demande pas de confirmation. --workspace sur rf et qa sélectionne le compte utilisé et facturé.

CommandeObjectif
champrep accountAfficher 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.
Fenêtre de terminal
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.

CommandeObjectif
champrep keys lsRépertorier vos clésAPI.
champrep keys createCréer une clé (--name, répétable --scope, --expires-in-days, --allowed-ip).
champrep keys get KEY_IDAfficher les détails d’une clé.
champrep keys audit KEY_IDAfficher le journal d’audit récent d’une clé.
champrep keys update KEY_IDModifier le nom, les champs d’application, la liste blanche d’adresses IP ou --active/--inactive.
champrep keys regenerate KEY_IDRemplacer le secret (l’ancien secret cesse de fonctionner).
champrep keys revoke KEY_IDSupprimer une clé.
Fenêtre de terminal
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.

CommandeObjectif
champrep billing subscriptionAfficher votre abonnement actuel (alias sub).
champrep billing cardsRépertorier les moyens de paiement enregistrés.
champrep billing receiptsRépertorier les reçus antérieurs.

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

CommandeObjectif
champrep webhooks lsRépertoriez vos webhooks.
champrep webhooks eventsListe des types d’événements auxquels vous pouvez vous abonner.
champrep webhooks createCréez un webhook (--url, reproductible --event). Le secret de signature s’affiche une seule fois.
champrep webhooks rotate WEBHOOK_IDEffectuez une rotation du secret de signature.
champrep webhooks rm WEBHOOK_IDSupprimer un webhook.

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

CommandeObjectif
champrep config get KEYLire une valeur de configuration.
champrep config set KEY VALUEDéfinissez une valeur de configuration autorisée. Un api_url ou web_url doit être un https:// adresse manquante.
champrep config listImprimez la configuration actuelle. Avec --json les clés sont celles propres au fichier (default_environment, api_url …).
champrep config pathAffichez le chemin d’accès au fichier de configuration.
champrep config env [NAME]Afficher ou définir l’environnement par défaut.
champrep completion SHELLGénérez la complétion pour Bash, Zsh, Fish ou PowerShell.
champrep versionVersion 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.

CodeSignification
0Succès.
1Échec général ou lié à l’utilisation, ou refus que la reconnexion ne permet pas de résoudre : accès refusé à l’élément, non inclus dans votre forfait, paiement ou crédits requis, problème lié à votre rôle, ou décision nécessitant votre session Web.
3L’authentification est requise ou n’est pas valide.
4Les identifiants ne disposent pas de la portée requise.
5Une limite en temps réel de la passerelle a été atteinte.
6Panne réseau.
7Défaillance de la passerelle ou du service.
8Un délai d’attente a expiré : code pipelines wait --timeout.

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.