Cycle de vie du projet Runtime d'invocation &Gestion des ressources &Ensembles de données d'évaluation Bundles de & configuration d'optimisation &Paramètres des opérations

AgentCore Référence CLI

Cette référence documente les versions publiques de la AgentCore CLI Amazon Bedrock.

Rubriques

Cycle de vie du projet
Runtime d'invocation &
Gestion des ressources
&Ensembles de données d'évaluation
Bundles de & configuration d'optimisation
&Paramètres des opérations

Cycle de vie du projet

Auto-generated à partir de la @aws/agentcore version 0.28.1 — ne pas modifier manuellement.

agentcore create


agentcore create [options]

Créer un nouveau AgentCore projet

Paramètres

--name <name> (facultatif): Nom de la ressource [non interactif]
--project-name <name> (facultatif): Nom du projet (commençant par une lettre, alphanumérique uniquement, 23 caractères maximum) [non interactif]
--no-agent (facultatif): Ignorer la création de l'agent [non interactif]
--defaults (facultatif): Créer un projet de harnais avec les paramètres par défaut (il s'agit des paramètres par défaut) [non interactif]
--build <type> (facultatif): Type de build : CodeZip ou Container (par défaut : CodeZip) [non interactif]
--language <language> (facultatif): Langue cible : Python ou TypeScript (par défaut : Python) [non interactif]
--framework <framework> (facultatif): Framework d'agents (Strands, LangChain _LangGraph, Google Adk, OpenAIAgents, VercelAI) [non interactif]
--model-provider <provider> (facultatif): Fournisseur de modèles (Bedrock, Anthropic, OpenAI, Gemini) [non interactif]
--api-key <key> (facultatif): Clé API pour les fournisseurs autres que Bedrock [non interactive]
--memory <option> (facultatif): Option de mémoire (aucune, ShortTerm, longueAndShortTerm) [non interactive]
--protocol <protocol> (facultatif): Protocole : HTTP, MCP, A2A, AGUI (par défaut : HTTP) [non interactif]
--type <type> (facultatif): Type d'agent : créer ou importer (par défaut : créer) [non interactif]
--agent-id <id> (facultatif): ID de l'agent Bedrock (obligatoire pour l'importation de --type) [non interactif]
--agent-alias-id <id> (facultatif): ID d'alias de l'agent Bedrock (obligatoire pour l'importation de --type) [non interactif]
--region <region> (facultatif): La AWS région de Bedrock Agent (obligatoire pour l'importation de --type) [non interactif]
--network-mode <mode> (facultatif): Mode réseau (PUBLIC, VPC) [non interactif]
--subnets <ids> (facultatif): Comma-separated ID de sous-réseau (requis pour le mode VPC) [non interactif]
--security-groups <ids> (facultatif): Comma-separated ID des groupes de sécurité (requis pour le mode VPC) [non interactif]
--vpc-id <id> (facultatif): ID VPC (requis pour les builds de conteneurs en mode VPC) [non interactif]
--idle-timeout <seconds> (facultatif): Délai d'inactivité en secondes (60-28800) [non interactif]
--max-lifetime <seconds> (facultatif): Durée de vie maximale de l'instance en secondes (60-28800) [non interactif]
--session-storage-mount-path <path> (facultatif): Chemin de montage absolu pour le stockage du système de fichiers de session sous /mnt (par exemple,/mnt/data) [non interactif]
--efs-access-point-arn <arn> (facultatif): ARN du point d'accès EFS (répétable, associé à --efs-mount-path) [non interactif] (par défaut : [])
--efs-mount-path <path> (facultatif): Chemin de montage EFS (par exemple,/mnt/tools, associé à --efs-access-point-arn) [non interactif] (par défaut : [])
--s3-access-point-arn <arn> (facultatif): ARN du point d'accès S3 Files (répétable, associé à --s3-mount-path) [non interactif] (par défaut : [])
--s3-mount-path <path> (facultatif): Chemin de montage des fichiers S3 (par exemple,/mnt/datasets, associé à --s3-access-point-arn) [non interactif] (par défaut : [])
--with-config-bundle (facultatif): Création d'un ensemble de configuration connecté au modèle d'agent [non interactif]
--output-dir <dir> (facultatif): Répertoire de sortie (par défaut : répertoire actuel) [non interactif]
--skip-git (facultatif): Ignorer l'initialisation du dépôt Git [non interactif]
--skip-python-setup (facultatif): Ignorer la configuration de l'environnement virtuel Python [non interactif]
--skip-install (facultatif): Ignorer toutes les installations de dépendances (npm install, uv sync) [non interactif]
--dry-run (facultatif): Prévisualisez ce qui serait créé sans apporter de modifications [non interactif]
--json (facultatif): Sortie au format JSON [non interactif]
--model-id <id> (facultatif): ID de modèle pour le harnais [non interactif]
--api-key-arn <arn> (facultatif): ARN de clé d'API pour les fournisseurs de harnais autres que Bedrock [non interactif]
--api-base <url> (facultatif): URL de base pour le point de terminaison de l'API du fournisseur de modèles de harnais (lite_llm) [non interactive]
--additional-params <json> (facultatif): Provider-specific exploiter les paramètres en tant qu'objet JSON (lite_llm) [non interactif]
--no-harness-memory (facultatif): Désactiver la mémoire pour le harnais (c'est la valeur par défaut) [non interactif]
--max-iterations <n> (facultatif): Nombre maximum d'itérations de la boucle d'agent (harnais) [non interactif]
--max-tokens <n> (facultatif): Nombre maximum de jetons par itération (harnais) [non interactif]
--timeout <seconds> (facultatif): Durée d'exécution maximale en secondes (harnais) [non interactif]
--truncation-strategy <strategy> (facultatif): Stratégie de troncature : sliding_window ou summarization (harness) [non interactif]
--container <uri-or-path> (facultatif): URI de l'image du conteneur ou chemin Dockerfile (harnais) [non interactif]

déploiement d'agentcore


agentcore deploy|dp [options]

Déployez l'infrastructure du projet AWS via CDK.

Paramètres

--target <target> (facultatif): Nom de la cible de déploiement (par défaut : « par défaut ») [non interactif]
-y, --yes (facultatif): Auto-confirm invite, lit les informations d'identification depuis env [non interactif]
-v, --verbose (facultatif): Afficher les événements de déploiement au niveau des ressources [non interactif]
--json (facultatif): Sortie au format JSON [non interactif]
--dry-run (facultatif): Aperçu du déploiement sans déploiement [non interactif]
--diff (facultatif): Afficher les différences CDK sans déployer [non interactif]

développeur agentcore


agentcore dev|d [options] [prompt]

Lancez le serveur de développement local ou appelez un agent localement.

Paramètres

prompt: Envoyer une invite à un serveur de développement en cours d'exécution [non interactif]
-p, --port <port> (facultatif): Port pour serveur de développement. Utilisé tel quel lorsqu'il est défini explicitement ; la valeur par défaut est compensée par l'index d'exécution dans les projets multi-exécutions. (par défaut : « 8080")
-r, --runtime <name> (facultatif): Runtime à exécuter ou à invoquer (obligatoire en cas d'exécution multiple)
-s, --stream (facultatif): Diffuser la réponse lors de l'invocation [non interactif]
-l, --logs (facultatif): Exécuter le serveur de développement avec des journaux sur stdout [non interactif]
--exec (facultatif): Exécutez une commande shell dans le conteneur de développement en cours d'exécution (agents de conteneur uniquement) [non interactif]
--tool <name> (facultatif): Nom de l'outil MCP (utilisé avec l'invite « call-tool ») [non interactif]
--input <json> (facultatif): Arguments de l'outil MCP au format JSON (utilisés avec --tool) [non interactif]
--skip-deploy (facultatif): Ignorer le déploiement automatique des ressources avant de démarrer le serveur de développement
-H, --header <header> (facultatif): En-tête personnalisé à transmettre à l'agent (format : « Nom : Valeur », répétable) [non interactif] (par défaut : [])
-b, --no-browser (facultatif): Utiliser le terminal TUI au lieu de l'interface utilisateur de chat basée sur le Web
--no-traces (facultatif): Désactiver la collecte de traces OTEL locale

paquet agentcore


agentcore package|pkg [options]

Empaquetez les artefacts de l'agent sans les déployer.

Paramètres

-d, --directory <path> (facultatif): Répertoire du projet contenant la configuration agentcore
-r, --runtime <name> (facultatif): Empaquetez uniquement le runtime spécifié

exportation agentcore


agentcore export [options] [command]

Exportez un harnais vers un agent d'exécution Strands.

mise à jour d'agentcore


agentcore update [options] [command]

Rechercher et installer les mises à jour de la CLI

Paramètres

-c, --check (facultatif): Rechercher les mises à jour sans les installer

validez agentcore


agentcore validate [options]

Validez les fichiers agentcore/config.

Paramètres

-d, --directory <path> (facultatif): Répertoire du projet contenant la configuration agentcore
--json (facultatif): Sortie au format JSON [non interactif]

Runtime d'invocation &

Auto-generated à partir de la @aws/agentcore version 0.28.1 — ne pas modifier manuellement.

invoquer agentcore


agentcore invoke|i [options] [prompt]

Invoquez le point de terminaison d'un agent déployé.

Paramètres

prompt: Demande à envoyer à l'agent. Accepte également le code stdin canalisé lorsqu'aucune invite n'est fournie et que stdin n'est pas un TTY [non interactif]
--prompt <text> (facultatif): Demande d'envoi à l'agent [non interactif]
--prompt-file <path> (facultatif): Lire l'invite depuis un fichier (pour les charges utiles longues ou structurées qui dépassent les limites d'argument shell) [non interactif]
--runtime <name> (facultatif): Sélectionnez un environnement d'exécution spécifique [non interactif]
--gateway <name> (facultatif): Invoquer via une passerelle [non interactif]
--gateway-target-name <name> (facultatif): Cible d'exécution HTTP sur la passerelle [non interactif]
--target <name> (facultatif): Sélectionnez la cible de déploiement [non interactif]
--session-id <id> (facultatif): Utiliser un identifiant de session spécifique pour assurer la continuité de la conversation
--user-id <id> (facultatif): ID utilisateur pour l'appel à l'exécution (par défaut : « default-user »)
--api-base <url> (facultatif): L'URL de base de l'API LiteLLM est remplacée pour les invocations de harnais. Disponible uniquement lite_llm en mode non interactif.
--additional-params <json> (facultatif): Les paramètres LiteLLM supplémentaires, en tant qu'objet JSON, pour les invocations de harnais. Disponible uniquement lite_llm en mode non interactif.
--payment-user-id <id> (facultatif): End-user/wallet-owner identity (par défaut, --user-id)
--payment-instrument-id <id> (facultatif): Identifiant de l'instrument de paiement (portefeuille)
--payment-session-id <id> (facultatif): ID de session de paiement pour le suivi du budget
--auto-session (facultatif): Auto-create/reuse une session de paiement pour les tests
--json (facultatif): Sortie au format JSON
--stream (facultatif): Diffusez la réponse en temps réel
--tool <name> (facultatif): Nom de l'outil MCP (à utiliser avec l'invite « call-tool »)
--input <json> (facultatif): Arguments de l'outil MCP au format JSON (à utiliser avec --tool)
--exec (facultatif): Exécuter une commande shell dans le conteneur d'exécution
--timeout <seconds> (facultatif): Délai d'attente en secondes pour les commandes --exec
-H, --header <header> (facultatif): En-tête personnalisé « Nom : Valeur » (répétable)
--bearer-token <token> (facultatif): Jeton porteur pour l'authentification CUSTOM_JWT (contourne SIGv4)
--harness <name> (facultatif): Sélectionnez un harnais spécifique à invoquer
--harness-arn <arn> (facultatif): Invoquer un harnais par ARN (aucun projet n'est requis)
--region <region> (facultatif): La AWS région (obligatoire avec --harness-arn)
--verbose (facultatif): Imprimer des événements JSON en streaming détaillés
--model-id <id> (facultatif): Remplacer le modèle
--model-provider <provider> (facultatif): Le fournisseur de modèles. Valeurs valides : bedrock, open_ai ou gemini.
--api-key-arn <arn> (facultatif): ARN de clé d'API pour open_ai/gemini
--tools <tools> (facultatif): Outils de remplacement (séparés par des virgules)
--allowed-tools <tools> (facultatif): Remplacer les outils autorisés (séparés par des virgules)
--skills <paths> (facultatif): Compétences (chemins séparés par des virgules)
--system-prompt <text> (facultatif): Ignorer l'invite du système
--actor-id <id> (facultatif): Remplacer l'ID de l'acteur de mémoire
--max-iterations <n> (facultatif): Annuler le nombre maximum d'itérations
--max-tokens <n> (facultatif): Annuler le nombre maximum de jetons
--harness-timeout <seconds> (facultatif): Annuler le délai d'attente en secondes

agent core exec


agentcore exec [options] [command...]

Ouvrez un shell interactif ou exécutez une commande unique dans un conteneur d'agents déployé.

Paramètres

command: Commande à exécuter (mode one-shot, non interactif)
--it (facultatif): Ouvrez une session PTY shell interactive
--runtime <name|arn> (facultatif): Nom de l'agent cible ou ARN d'exécution (ignore le sélecteur d'agent)
--harness <name|arn> (facultatif): Nom du harnais cible ou ARN du harnais (ignore le sélecteur d'agent)
--session-id <id> (facultatif): Épingler à une session d'exécution ou à une machine virtuelle spécifique
--shell-id <id> (facultatif): Reconnexion à un shell existant
--region <region> (facultatif): La AWS région
--bearer-token <token> (facultatif): Jeton porteur pour l'authentification CUSTOM_JWT (ignore SIGv4)
--target <name> (facultatif): Nom de la cible de déploiement (extrait de agentcore.json)
--timeout <seconds> (facultatif): Délai d'attente en secondes pour les commandes à exécution unique
--json (facultatif): Résultat de sortie au format JSON (mode one-shot uniquement, incompatible avec --it)

exécuter agentcore


agentcore run [options] [command]

Exécutez des évaluations, des évaluations par lots ou des recommandations d'optimisation.

journaux agentcore


agentcore logs|l [options] [command]

Journaux d'exécution des agents de diffusion ou de recherche.

Paramètres

--runtime <name> (facultatif): Sélectionnez un temps d'exécution spécifique
--since <time> (facultatif): Heure de début : par défaut, il y a 1h en mode recherche (par exemple, « 1h », « 30m », « 2d », ISO 8601)
--until <time> (facultatif): Heure de fin : la valeur par défaut est maintenant en mode de recherche (par exemple, « maintenant », ISO 8601)
--level <level> (facultatif): Filtrer par niveau de journalisation (erreur, avertissement, info, débogage)
-n, --limit <count> (facultatif): Nombre maximum de lignes de journal à renvoyer
--query <text> (facultatif): Server-side filtre de texte
--json (facultatif): Sortie sous forme de lignes JSON

traces d'agentcore


agentcore traces|t [options] [command]

Consultez et téléchargez les traces des agents.

statut agentcore


agentcore status|s [options]

Afficher les détails et l'état des ressources déployées.

Paramètres

--runtime-id <id> (facultatif): Rechercher un environnement d'exécution spécifique par identifiant
--target <name> (facultatif): Sélectionnez la cible de déploiement
--type <type> (facultatif): Filtrer par type de ressource (agent, point d'exécution, mémoire, informations d'identification, passerelle, évaluateur, évaluation en ligne, paiement, moteur de politiques, politique, ensemble de configuration, ensemble de données, base de connaissances, harnais)
--state <state> (facultatif): Filtrer par état de déploiement (déployé, local uniquement, en attente de suppression)
--runtime <name> (facultatif): Filtrer en fonction d'une durée d'exécution spécifique
--name <name> (facultatif): Afficher les détails d'une seule ressource par son nom (base de connaissances)
--json (facultatif): Sortie au format JSON

récupérer agentcore


agentcore fetch [options] [command]

Récupérez les informations d'accès pour les ressources déployées.

vue agentcore


agentcore view [options] [command]

Afficher l'historique et les détails des offres d'emploi

Gestion des ressources

Auto-generated à partir de la @aws/agentcore version 0.28.1 — ne pas modifier manuellement.

ajouter agentcore


agentcore add [options] [command] [subcommand]

Ajoutez des ressources à la configuration du projet.

agentcore supprimer


agentcore remove [options] [command] [subcommand]

Supprimez les ressources de la configuration du projet.

importation d'agentcore


agentcore import [options] [command]

Importez une boîte à outils d'exécution, de mémoire ou de démarrage dans ce projet.

Paramètres

--source <path> (facultatif): Chemin d'accès au fichier de configuration .bedrock_agentcore.yaml
--target <target> (facultatif): Nom de la cible de déploiement (nécessaire uniquement si le projet comporte plusieurs cibles)
-y, --yes (facultatif): Auto-confirm invite

&Ensembles de données d'évaluation

Auto-generated à partir de la @aws/agentcore version 0.28.1 — ne pas modifier manuellement.

évaluations agentcore


agentcore evals [options] [command]

Afficher les résultats de l'évaluation enregistrée et de l'évaluation par lots des exécutions précédentes.

évaluations par lots d'agentcore


agentcore batch-evaluations [options] [command] <id>

Consultez les tâches d'évaluation par lots et leurs résultats.

Paramètres

id: ID de tâche d'évaluation par lots à afficher
--json (facultatif): Sortie au format JSON

jeu de données agentcore


agentcore dataset [options] [command]

Gérer le contenu et les versions des jeux de données

Bundles de & configuration d'optimisation

Auto-generated à partir de la @aws/agentcore version 0.28.1 — ne pas modifier manuellement.

bundle de configuration agentcore


agentcore config-bundle|cb [options] [command]

Gérer les ensembles de configuration (utiliser le nom du bundle d'agentcore.json, pas l'ID)

promotion d'agentcore


agentcore promote [options] [command]

Promouvoir les ressources

archive agentcore


agentcore archive [options] [command]

Archivez (supprimez) une évaluation par lots ou une recommandation sur le service et effacez l'historique local.

&Paramètres des opérations

Auto-generated à partir de la @aws/agentcore version 0.28.1 — ne pas modifier manuellement.

pause agentcore


agentcore pause [options] [command]

Suspendre une ressource déployée (configuration d'évaluation en ligne, A/B test).

CV Agentcore


agentcore resume [options] [command]

Reprendre une ressource en pause (configuration d'évaluation en ligne, A/B test).

arrêt agentcore


agentcore stop [options] [command]

Arrêtez une évaluation ou un A/B test par lots en cours.

configuration agentcore


agentcore config [options] [key] [value]

Ajustez les paramètres de configuration généraux tels que l'état de désactivation de la télémétrie

Paramètres

key: Clé de configuration en notation par points (par exemple, telemetry.enabled)
value: Valeur à définir

télémétrie agentcore


agentcore telemetry [options] [command]

Gérez les préférences d'analyse anonyme de l'utilisation.

commentaires d'agentcore


agentcore feedback [options] [message]

Envoyez des commentaires sur la AgentCore CLI à l'équipe.

Paramètres

message: Message de feedback [non interactif]
--screenshot <path> (facultatif): Chemin d'accès à une capture d'écran PNG ou JPG (100 Mo maximum) [non interactif]
--json (facultatif): Résultat de sortie au format JSON [non interactif]

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Guide de migration des registres

AgentCore Référence du SDK Python

AgentCore Référence CLI

Rubriques

Cycle de vie du projet

agentcore create

déploiement d'agentcore

développeur agentcore

paquet agentcore

exportation agentcore

mise à jour d'agentcore

validez agentcore

Runtime d'invocation &amp;

invoquer agentcore

agent core exec

exécuter agentcore

journaux agentcore

traces d'agentcore

statut agentcore

récupérer agentcore

vue agentcore

Gestion des ressources

ajouter agentcore

agentcore supprimer

importation d'agentcore

&amp;Ensembles de données d'évaluation

évaluations agentcore

évaluations par lots d'agentcore

jeu de données agentcore

Bundles de &amp; configuration d'optimisation

bundle de configuration agentcore

promotion d'agentcore

archive agentcore

&amp;Paramètres des opérations

pause agentcore

CV Agentcore

arrêt agentcore

configuration agentcore

télémétrie agentcore

commentaires d'agentcore

Runtime d'invocation &

&Ensembles de données d'évaluation

Bundles de & configuration d'optimisation

&Paramètres des opérations