Références de la CLI

La commande agents crée un projet d'agent, exécute l'agent sur votre machine, le déploie sur Mistral et permet de lui parler depuis le terminal. Les guides présentent l'utilisation de chaque commande : Guide de démarrage, Auto-hébergés (agents serve), Gérés par Mistral (agents deploy) et Cycle de vie d'un agent.

La commande agents est fournie avec le package mistralai-agents : consultez Installer sans agents init.

Commandes

Commandes

Je souhaiteCommande
Créer un projet prêt à être déployéagents init NAME
Voir ce que la CLI charge depuis mon projetagents info [PATH]
Exécuter l'agent sur ma machine en auto-hébergementagents serve [PATH]
Déployer l'agent avec une gestion par Mistralagents deploy [PATH]
Voir les agents de mon espace de travailagents list
Lire les logs d'un agent déployéagents logs NAME
Parler à un agentagents chat [NAME]
Arrêter définitivement un agentagents shutdown NAME
Installer un skill pour mon agent de codageagents skills add NAME

Un projet passe par quatre étapes :

  1. agents init my-agent le crée.
  2. agents info affiche ce que la CLI charge depuis le projet.
  3. agents serve l'exécute sur votre machine, et agents chat my-agent permet de lui parler.
  4. agents deploy le déploie sur Mistral.

agents info, agents serve et agents deploy prennent comme argument la racine du projet, . par défaut. Les commandes y recherchent agent dans main.py, ou le module:attr défini dans pyproject.toml :

[tool.mistralai.agents]
entrypoint = "src.service:support_agent"

L'agent doit définir name=. Consultez Auto-hébergés (agents serve).

Options globales

Options globales

agents [OPTIONS] COMMAND [ARGS]...
OptionFonction
--versionAffiche la version installée, par exemple mistralai-agents 1.1.0, puis se termine.
--install-completionInstalle l'autocomplétion pour le shell actuel.
--show-completionAffiche le script d'autocomplétion du shell actuel pour vous permettre de le copier ou de le personnaliser.
--helpAffiche l'aide, puis se termine. Chaque commande accepte aussi cette option.

Sans commande, agents affiche l'aide, puis se termine avec le code de sortie 2.

agents init

agents init

agents init [OPTIONS] [NAME]

Crée un projet d'agent dans un dossier nommé NAME, prêt pour agents deploy. La commande verrouille les dépendances du projet avec uv, puis vous demande votre clé API et l'enregistre dans .env.

Argument ou optionFonction
NAMELe nom de l'agent et du dossier du projet.
--name NAMEMême fonction, sous forme d'option. Fournir deux noms différents provoque une erreur.
--yes, -yInstalle uv s'il est absent, ne demande pas de clé API, crée un fichier .env vide et crée un commit du projet dans un nouveau dépôt git. Si vous n'avez pas fourni de nom, la commande le demande tout de même lorsqu'un terminal est disponible.
--no-gitNe crée pas de dépôt git.
--exempt-from-exclude-newerExempte le SDK de la date limite uv exclude-newer, qui pourrait masquer une version récente.

Sans nom ni terminal permettant de le demander, la commande s'arrête avec le message No agent name was given. Run `agents init NAME`. Pour en savoir plus, consultez Guide de démarrage.

agents info

agents info

agents info [PATH]

Affiche l'agent que la CLI charge depuis le projet situé à PATH : son modèle, ses instructions, ses outils, connecteurs, MCP, skills, mécanismes de contrôle, hooks, sous-agents et autorisations. Pour un fichier main.py contenant un seul outil :

Output
pr-reviewer mistral-large-4
instructions You review pull requests.
sandbox none
tools
client.search
connectors (none)
mcps (none)
skills (none)
guardrails (none)
hooks (none)
subagents (none)
subagent policy (none)
permissions auto · no policy

Lorsque les vérifications détectent des problèmes, la commande les liste sous checks : ✗ pour une erreur, ⚠ pour un avertissement. Elle indique le premier élément qu'elle n'a pas pu charger et se termine avec le code de sortie 1 si elle ne trouve aucun agent ou si une vérification détecte une erreur. Pour en savoir plus, consultez Auto-hébergés (agents serve).

agents serve

agents serve

agents serve [OPTIONS] [PATH]

Exécute l'agent sur votre machine, l'enregistre dans votre espace de travail et affiche un lien pour le déclencher. Ctrl+C l'arrête.

Argument ou optionFonction
PATHLa racine du projet. Par défaut : ..
--name NAMEEnregistre l'agent sous ce nom plutôt que celui défini dans son code.
--send-config / --no-send-configEnvoie la configuration de l'agent à Mistral, comme le fait agents deploy, pour qu'elle s'affiche avec l'agent et ses sessions dans votre espace de travail. Un redémarrage avec la même configuration et la même version du code n'enregistre pas de nouvelle copie. Par défaut : --send-config ; --no-send-config enregistre l'agent sans sa configuration. Variable d'environnement : AGENTS_SDK_SERVE_SEND_CONFIG.

La commande affiche uniquement les avertissements et la bannière ; AGENTS_SDK_DEBUG=1 affiche les logs complets. Pour en savoir plus, consultez Auto-hébergés (agents serve).

agents deploy

agents deploy

agents deploy [OPTIONS] [PATH]

Construit une image à partir du projet et la déploie sur Mistral, dans votre espace de travail. Un nouveau déploiement sous un nom existant remplace l'agent qui porte ce nom.

Argument ou optionFonction
PATHLa racine du projet. Par défaut : ..
--name NAMEDéploie l'agent sous ce nom plutôt que celui défini dans son code.
--hardened / --no-hardenedRenforce la sécurité du déploiement pour que l'agent puisse utiliser des connecteurs et des MCP au nom de l'utilisateur qui a démarré la session. Par défaut : sécurité renforcée lorsque l'agent agit au nom de l'utilisateur de la session. Cette protection est nécessaire pour un tel agent : avec --no-hardened, son déploiement ne démarre pas.
--dockerfile PATHLe Dockerfile à utiliser pour la construction, avec un chemin relatif au projet. Par défaut : Dockerfile.
--secret-binding ENV_VAR=secret:workspace:NAMELie un secret de l'espace de travail à une variable d'environnement de l'agent déployé. Fournissez la référence, jamais la valeur du secret. Répétez l'option pour chaque variable. Ces options définissent l'ensemble des liaisons : un déploiement sans cette option supprime les liaisons aux secrets établies par un déploiement précédent.
--yes, -yCrée les fichiers Dockerfile et .python-version manquants sans demander de confirmation.

Ctrl+C pendant l'attente du déploiement arrête l'attente, pas le déploiement : le déploiement de l'agent se poursuit, et agents deploy se termine avec le code de sortie 130. Pour en savoir plus, consultez Gérés par Mistral (agents deploy) : utilisation de votre propre Dockerfile, secrets et traçage.

agents list

agents list

agents list

Liste les agents de votre espace de travail, leur mode d'exécution et leur état d'exécution. Cette commande n'accepte aucune option.

Output
NAME KIND STATUS
hello-agent deployed running
draft-agent served not observed

not observed signifie que Mistral n'a observé aucune exécution de l'agent : il est arrêté, ou son état n'a pas pu être lu. Pour en savoir plus, consultez Cycle de vie d'un agent.

agents logs

agents logs

agents logs [OPTIONS] NAME

Affiche les dernières lignes des logs d'un agent déployé. Les logs d'un agent exécuté localement se trouvent dans le terminal qui exécute agents serve.

Argument ou optionFonction
NAMEL'agent déployé. Obligatoire.
--follow, -fAffiche les nouvelles lignes au fur et à mesure de leur écriture.
--lines N, -n NLe nombre de dernières lignes à afficher au départ, de 1 à 1000. Par défaut : 100.
--timestamps, -tAjoute l'horodatage au début de chaque ligne.
--level LEVEL, -l LEVELAffiche uniquement les lignes de ce niveau ou d'un niveau supérieur : debug, info, warning ou error. Les lignes indentées sous une ligne conservée, comme une trace d'erreur, sont également conservées.
--jsonAffiche un objet JSON par ligne, avec time, stream, level, logger, message et fields.

Pour en savoir plus, consultez Cycle de vie d'un agent.

agents chat

agents chat

agents chat [OPTIONS] [NAME]

Permet de parler à un agent depuis le terminal. Avec NAME, la commande contacte l'agent de ce nom, qu'il soit auto-hébergé ou géré par Mistral. Sans cet argument, elle exécute l'agent du projet dans ce processus, sans rien enregistrer.

Argument ou optionFonction
NAMEL'agent auquel parler, auto-hébergé ou géré par Mistral. Omettez cet argument pour exécuter l'agent du projet dans ce processus.
--path PATHLa racine du projet, lorsque vous omettez NAME. Par défaut : ..
--message TEXT, -m TEXTEnvoie ce seul message, affiche la réponse, puis se termine. Le code de sortie est 1 si le tour de conversation n'est pas allé à son terme.

Pendant un tour de conversation, Ctrl+C l'interrompt et laisse la conversation ouverte. À l'invite de commande, Ctrl+C, Ctrl+D, /exit ou /quit met fin à la conversation. Avec permission_mode="ask", la conversation demande une autorisation avant chaque appel d'outil : y l'autorise une fois, a l'autorise pour le reste de la session, n le refuse. L'approbation d'un hook propose uniquement y et n. agents chat refuse immédiatement tout appel d'outil côté client, et le tour de conversation se poursuit. Pour en savoir plus, consultez Cycle de vie d'un agent.

agents shutdown

agents shutdown

agents shutdown [OPTIONS] NAME

Arrête définitivement un agent. NAME est le nom sous lequel l'agent est déployé, éventuellement modifié par --name.

Argument ou optionFonction
NAMEL'agent à arrêter. Obligatoire.
--yes, -yIgnore la demande de confirmation.

Pour en savoir plus, consultez Cycle de vie d'un agent.

agents skills add

agents skills add

agents skills add NAME

Installe un skill livré par le SDK dans .agents/skills/ du dossier courant, pour votre agent de codage : exécutez la commande à la racine de votre projet. migrate-1.1 migre un projet d'une version candidate 1.1 vers 1.1. Une nouvelle exécution remplace les fichiers installés par ceux du SDK installé. migrate-1.1 migre également un projet depuis Agents SDK 1.0.7.

ArgumentFonction
NAMELe skill à installer : migrate-1.1.
uvx --python 3.12 --from mistralai-agents agents skills add migrate-1.1

--python 3.12 empêche uvx d'utiliser Python 3.14t sans GIL, avec lequel l'installation échoue.

Codes de sortie

Codes de sortie

CodeSignification
0Réussite, ou Ctrl+C pendant agents serve ou agents logs --follow.
1La commande a échoué et en a affiché la raison. agents chat se termine aussi avec le code 1 en cas de perte de connexion à la session.
2Une erreur d'utilisation : option inconnue, argument manquant ou valeur hors limites.
130agents deploy a cessé d'attendre après Ctrl+C ; le déploiement se poursuit en arrière-plan.
Environnement

Environnement

VariableLue parCe qu'elle définit
MISTRAL_API_KEYchaque commande qui appelle l'APIVotre clé API.
MISTRAL_API_URLchaque commande qui appelle l'APILa racine de l'API, sans /v1.
AGENTS_SDK_SERVE_SEND_CONFIGagents serveLa valeur par défaut de --send-config.
AGENTS_SDK_CODE_VERSIONagents serveLa version du code : un redémarrage avec la même valeur conserve l'agent. Par défaut : une empreinte du projet. Consultez Cycle de vie d'un agent.
AGENTS_SDK_DEBUGchaque commande et tout programme qui importe le SDK1 affiche les logs complets.

Exportez les variables dans votre shell ou chargez .env avec uv run --env-file .env agents ... ; une variable exportée par votre shell est prioritaire sur celle du fichier.

  • L'API complète : tous les appels Python, classés selon ce que vous souhaitez faire.