View a markdown version of this page

AgentCore Referência da CLI - Base da Amazônia AgentCore

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

AgentCore Referência da CLI

Essa referência documenta os lançamentos públicos da AgentCore CLI do Amazon Bedrock.

Ciclo de vida do projeto

Auto-generated da @aws/agentcore v0.28.1 — não edite manualmente.

agentcore create

agentcore create [options]

Crie um novo AgentCore projeto

Parâmetros

--name <name> (opcional)

Nome do recurso [não interativo]

--project-name <name> (opcional)

Nome do projeto (comece com letra, somente alfanumérico, máximo de 23 caracteres) [não interativo]

--no-agent (opcional)

Ignorar a criação do agente [não interativo]

--defaults (opcional)

Crie um projeto de equipamento com configurações padrão (esse é o padrão) [não interativo]

--build <type> (opcional)

Tipo de compilação: CodeZip ou Contêiner (padrão: CodeZip) [não interativo]

--language <language> (opcional)

Idioma de destino: Python ou TypeScript (padrão: Python) [não interativo]

--framework <framework> (opcional)

Estrutura de agentes (Strands, LangChain _, GoogleAdkLangGraph, OpenAIAgents, VercelAI) [não interativa]

--model-provider <provider> (opcional)

Fornecedor de modelos (Bedrock, Anthropic, OpenAI, Gemini) [não interativo]

--api-key <key> (opcional)

Chave de API para fornecedores que não são da Bedrock [não interativa]

--memory <option> (opcional)

Opção de memória (nenhuma, de curto prazo, longaAndShortTerm) [não interativa]

--protocol <protocol> (opcional)

Protocolo: HTTP, MCP, A2A, AGUI (padrão: HTTP) [não interativo]

--type <type> (opcional)

Tipo de agente: criar ou importar (padrão: criar) [não interativo]

--agent-id <id> (opcional)

ID do agente Bedrock (necessário para importação de --type) [não interativo]

--agent-alias-id <id> (opcional)

ID do alias do agente Bedrock (necessário para importação de --type) [não interativo]

--region <region> (opcional)

A AWS região do Bedrock Agent (necessária para importação de --type) [não interativa]

--network-mode <mode> (opcional)

Modo de rede (PUBLIC, VPC) [não interativo]

--subnets <ids> (opcional)

Comma-separated IDs de sub-rede (necessários para o modo VPC) [não interativos]

--security-groups <ids> (opcional)

Comma-separated IDs de grupos de segurança (necessários para o modo VPC) [não interativos]

--vpc-id <id> (opcional)

ID da VPC (necessária para compilações de contêineres com o modo VPC) [não interativa]

--idle-timeout <seconds> (opcional)

Tempo limite da sessão ociosa em segundos (60-28800) [não interativo]

--max-lifetime <seconds> (opcional)

Vida útil máxima da instância em segundos (60-28800) [não interativa]

--session-storage-mount-path <path> (opcional)

Caminho de montagem absoluto para armazenamento do sistema de arquivos da sessão em /mnt (por exemplo,/) [não interativo] mnt/data

--efs-access-point-arn <arn> (opcional)

Ponto de acesso EFS ARN (repetível, emparelhado com --efs-mount-path) [não interativo] (padrão: [])

--efs-mount-path <path> (opcional)

Caminho de montagem do EFS (por exemplo,/mnt/tools, emparelhado com --efs-access-point-arn) [não interativo] (padrão: [])

--s3-access-point-arn <arn> (opcional)

Ponto de acesso ARN do S3 Files (repetível, emparelhado com --s3-mount-path) [não interativo] (padrão: [])

--s3-mount-path <path> (opcional)

Caminho de montagem dos arquivos S3 (por exemplo,/mnt/datasets, emparelhado com --s3-access-point-arn) [não interativo] (padrão: [])

--with-config-bundle (opcional)

Crie um pacote de configuração conectado ao modelo do agente [não interativo]

--output-dir <dir> (opcional)

Diretório de saída (padrão: diretório atual) [não interativo]

--skip-git (opcional)

Ignorar a inicialização do repositório git [não interativo]

--skip-python-setup (opcional)

Ignorar a configuração do ambiente virtual Python [não interativo]

--skip-install (opcional)

Ignorar todas as instalações de dependências (npm install, uv sync) [não interativo]

--dry-run (opcional)

Visualize o que seria criado sem fazer alterações [não interativo]

--json (opcional)

Saída como JSON [não interativa]

--model-id <id> (opcional)

ID do modelo para arnês [não interativo]

--api-key-arn <arn> (opcional)

ARN da chave de API para fornecedores de equipamentos não Bedrock [não interativo]

--api-base <url> (opcional)

URL base para o endpoint da API do provedor do modelo harness (lite_llm) [não interativo]

--additional-params <json> (opcional)

Provider-specific aproveitar parâmetros como um objeto JSON (lite_llm) [não interativo]

--no-harness-memory (opcional)

Desative a memória do chicote (esse é o padrão) [não interativo]

--max-iterations <n> (opcional)

Máximo de iterações do loop do agente (harness) [não interativo]

--max-tokens <n> (opcional)

Máximo de tokens por iteração (harness) [não interativo]

--timeout <seconds> (opcional)

Duração máxima da execução em segundos (harness) [não interativo]

--truncation-strategy <strategy> (opcional)

Estratégia de truncamento: sliding_window ou summarization (harness) [não interativo]

--container <uri-or-path> (opcional)

URI da imagem do contêiner ou caminho do Dockerfile (harness) [não interativo]

implantação do agentcore

agentcore deploy|dp [options]

Implante a infraestrutura do projeto AWS via CDK.

Parâmetros

--target <target> (opcional)

Nome do alvo de implantação (padrão: “padrão”) [não interativo]

-y, --yes (opcional)

Auto-confirm prompts, leia as credenciais do env [não interativo]

-v, --verbose (opcional)

Mostrar eventos de implantação em nível de recurso [não interativo]

--json (opcional)

Saída como JSON [não interativa]

--dry-run (opcional)

Visualize a implantação sem implantar [não interativo]

--diff (opcional)

Mostrar diferenças do CDK sem implantar [não interativo]

desenvolvedor do agentcore

agentcore dev|d [options] [prompt]

Inicie o servidor de desenvolvimento local ou invoque um agente localmente.

Parâmetros

prompt

Enviar um prompt para um servidor de desenvolvimento em execução [não interativo]

-p, --port <port> (opcional)

Porta para servidor de desenvolvimento. Usado como está quando definido explicitamente; o padrão é compensado pelo índice de tempo de execução em projetos com vários tempos de execução. (padrão: “8080")

-r, --runtime <name> (opcional)

Tempo de execução a ser executado ou invocado (necessário se houver vários tempos de execução)

-s, --stream (opcional)

Resposta do stream ao invocar [não interativo]

-l, --logs (opcional)

Execute o servidor de desenvolvimento com registros em stdout [não interativo]

--exec (opcional)

Execute um comando shell no contêiner de desenvolvimento em execução (somente agentes de contêiner) [não interativo]

--tool <name> (opcional)

Nome da ferramenta MCP (usado com o prompt “ferramenta de chamada”) [não interativo]

--input <json> (opcional)

Argumentos da ferramenta MCP como JSON (usados com --tool) [não interativos]

--skip-deploy (opcional)

Ignore a implantação automática de recursos antes de iniciar o servidor de desenvolvimento

-H, --header <header> (opcional)

Cabeçalho personalizado para encaminhar ao agente (formato: “Nome: Valor”, repetível) [não interativo] (padrão: [])

-b, --no-browser (opcional)

Use o terminal TUI em vez da interface de bate-papo baseada na web

--no-traces (opcional)

Desativar a coleta de rastreamento OTEL local

pacote agentcore

agentcore package|pkg [options]

Artefatos do agente de pacotes sem implantação.

Parâmetros

-d, --directory <path> (opcional)

Diretório do projeto contendo a configuração do agentcore

-r, --runtime <name> (opcional)

Empacote somente o tempo de execução especificado

exportação do agentcore

agentcore export [options] [command]

Exporte um chicote para um agente de tempo de execução Strands.

atualização do agentcore

agentcore update [options] [command]

Verifique e instale atualizações da CLI

Parâmetros

-c, --check (opcional)

Verifique se há atualizações sem instalar

validação do agentcore

agentcore validate [options]

Valide os arquivos agentcore/ config.

Parâmetros

-d, --directory <path> (opcional)

Diretório do projeto contendo a configuração do agentcore

--json (opcional)

Saída como JSON [não interativa]

Tempo de execução de &amp; invocação

Auto-generated da @aws/agentcore v0.28.1 — não edite manualmente.

invocação do agentcore

agentcore invoke|i [options] [prompt]

Invoque um endpoint de agente implantado.

Parâmetros

prompt

Solicitação de envio ao agente. Também aceita stdin canalizado quando nenhum prompt é fornecido e stdin não é um TTY [não interativo]

--prompt <text> (opcional)

Solicitação de envio ao agente [não interativa]

--prompt-file <path> (opcional)

Leia a solicitação de um arquivo (para cargas longas ou estruturadas que excedam os limites de argumentos do shell) [não interativo]

--runtime <name> (opcional)

Selecione um tempo de execução específico [não interativo]

--gateway <name> (opcional)

Invoque por meio de um gateway [não interativo]

--gateway-target-name <name> (opcional)

Alvo de tempo de execução HTTP no gateway [não interativo]

--target <name> (opcional)

Selecione o alvo de implantação [não interativo]

--session-id <id> (opcional)

Use um ID de sessão específico para a continuidade da conversa

--user-id <id> (opcional)

ID de usuário para invocação de tempo de execução (padrão: “usuário padrão”)

--api-base <url> (opcional)

A substituição do URL base da API LiteLM para aproveitar as invocações. Disponível somente lite_llm no modo não interativo.

--additional-params <json> (opcional)

Os parâmetros adicionais do LiteLM, como um objeto JSON, para aproveitar as invocações. Disponível somente lite_llm no modo não interativo.

--payment-user-id <id> (opcional)

End-user/wallet-owner identidade (o padrão é --user-id)

--payment-instrument-id <id> (opcional)

ID do instrumento de pagamento (carteira)

--payment-session-id <id> (opcional)

ID da sessão de pagamento para rastreamento de orçamento

--auto-session (opcional)

Auto-create/reuse uma sessão de pagamento para testes

--json (opcional)

Saída como JSON

--stream (opcional)

Resposta de streaming em tempo real

--tool <name> (opcional)

Nome da ferramenta MCP (use com o prompt “ferramenta de chamada”)

--input <json> (opcional)

Argumentos da ferramenta MCP como JSON (use com --tool)

--exec (opcional)

Execute um comando shell no contêiner de tempo de execução

--timeout <seconds> (opcional)

Tempo limite em segundos para comandos --exec

-H, --header <header> (opcional)

Cabeçalho personalizado “Nome: Valor” (repetível)

--bearer-token <token> (opcional)

Token portador para autenticação CUSTOM_JWT (ignora SigV4)

--harness <name> (opcional)

Selecione um equipamento específico para invocar

--harness-arn <arn> (opcional)

Invoque um arnês pelo ARN (nenhum projeto é necessário)

--region <region> (opcional)

A AWS região (necessária com --harness-arn)

--verbose (opcional)

Imprima eventos JSON de streaming detalhados

--model-id <id> (opcional)

Substituir modelo

--model-provider <provider> (opcional)

O fornecedor do modelo. Valores válidos: bedrock, open_ai ou gemini.

--api-key-arn <arn> (opcional)

ARN da chave de API para open_ai/gemini

--tools <tools> (opcional)

Ferramentas de substituição (separadas por vírgula)

--allowed-tools <tools> (opcional)

Substituir ferramentas permitidas (separadas por vírgula)

--skills <paths> (opcional)

Habilidades (caminhos separados por vírgula)

--system-prompt <text> (opcional)

Ignorar a solicitação do sistema

--actor-id <id> (opcional)

Substituir ID do ator de memória

--max-iterations <n> (opcional)

Substituir o máximo de iterações

--max-tokens <n> (opcional)

Substituir o máximo de tokens

--harness-timeout <seconds> (opcional)

Substituir segundos de tempo limite

agente executivo

agentcore exec [options] [command...]

Abra um shell interativo ou execute um comando único em um contêiner de agente implantado.

Parâmetros

command

Comando para executar (modo one-shot, não interativo)

--it (opcional)

Abra uma sessão interativa do shell PTY

--runtime <name|arn> (opcional)

Nome do agente de destino ou ARN de tempo de execução (ignora o seletor de agentes)

--harness <name|arn> (opcional)

Nome do chicote alvo ou ARN do equipamento (ignora o seletor de agentes)

--session-id <id> (opcional)

Fixar em uma sessão/VM de tempo de execução específica

--shell-id <id> (opcional)

Reconecte-se a um shell existente

--region <region> (opcional)

A AWS região

--bearer-token <token> (opcional)

Token portador para autenticação CUSTOM_JWT (ignora SigV4)

--target <name> (opcional)

Nome do alvo de implantação (de agentcore.json)

--timeout <seconds> (opcional)

Tempo limite em segundos para comandos únicos

--json (opcional)

Resultado de saída como JSON (somente no modo one-shot, incompatível com --it)

execução do agentcore

agentcore run [options] [command]

Execute avaliações, avaliações em lote ou recomendações de otimização.

registros do agentcore

agentcore logs|l [options] [command]

Transmita ou pesquise registros de tempo de execução do agente.

Parâmetros

--runtime <name> (opcional)

Selecione um tempo de execução específico

--since <time> (opcional)

Hora de início — o padrão é 1h atrás no modo de pesquisa (por exemplo, “1h”, “30m”, “2d”, ISO 8601)

--until <time> (opcional)

Hora de término — o padrão é agora no modo de pesquisa (por exemplo, “agora”, ISO 8601)

--level <level> (opcional)

Filtrar por nível de registro (erro, aviso, informações, depuração)

-n, --limit <count> (opcional)

Número máximo de linhas de registro a serem retornadas

--query <text> (opcional)

Server-side filtro de texto

--json (opcional)

Saída como linhas JSON

traços do agentcore

agentcore traces|t [options] [command]

Visualize e baixe rastreamentos do agente.

status do agentcore

agentcore status|s [options]

Mostre detalhes e status dos recursos implantados.

Parâmetros

--runtime-id <id> (opcional)

Pesquise um tempo de execução específico por ID

--target <name> (opcional)

Selecione o alvo de implantação

--type <type> (opcional)

Filtrar por tipo de recurso (agente, endpoint de tempo de execução, memória, credencial, gateway, avaliador, avaliação on-line, pagamento, mecanismo de políticas, política, pacote de configuração, conjunto de dados, base de conhecimento, aproveitamento)

--state <state> (opcional)

Filtrar por estado de implantação (implantado, somente local, remoção pendente)

--runtime <name> (opcional)

Filtrar para um tempo de execução específico

--name <name> (opcional)

Mostrar detalhes de um único recurso por nome (base de conhecimento)

--json (opcional)

Saída como JSON

busca do agentcore

agentcore fetch [options] [command]

Obtenha informações de acesso aos recursos implantados.

visão do agentcore

agentcore view [options] [command]

Visualize o histórico e os detalhes do trabalho

Gerenciamento de recursos

Auto-generated da @aws/agentcore v0.28.1 — não edite manualmente.

agentcore add

agentcore add [options] [command] [subcommand]

Adicione recursos à configuração do projeto.

remoção do agentcore

agentcore remove [options] [command] [subcommand]

Remova os recursos da configuração do projeto.

importação de agentcore

agentcore import [options] [command]

Importe um tempo de execução, memória ou kit de ferramentas inicial para este projeto.

Parâmetros

--source <path> (opcional)

Caminho para o arquivo de configuração .bedrock_agentcore.yaml

--target <target> (opcional)

Nome do alvo de implantação (necessário somente se o projeto tiver vários alvos)

-y, --yes (opcional)

Auto-confirm avisos

&amp;Conjuntos de dados de avaliação

Auto-generated da @aws/agentcore v0.28.1 — não edite manualmente.

avaliações do AgentCore

agentcore evals [options] [command]

Visualize os resultados de avaliação salvos e de avaliação em lote de execuções anteriores.

avaliações em lote do agentcore

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

Visualize os trabalhos de avaliação em lote e seus resultados.

Parâmetros

id

ID do trabalho de avaliação em lote para visualizar

--json (opcional)

Saída como JSON

conjunto de dados agentcore

agentcore dataset [options] [command]

Gerencie o conteúdo e as versões do conjunto de dados

Pacotes de &amp; configuração de otimização

Auto-generated da @aws/agentcore v0.28.1 — não edite manualmente.

pacote de configuração do agentcore

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

Gerencie pacotes de configuração (use o nome do pacote de agentcore.json, não o ID)

agentcore promote

agentcore promote [options] [command]

Promova recursos

arquivo agentcore

agentcore archive [options] [command]

Arquive (exclua) uma avaliação ou recomendação em lote sobre o serviço e limpe o histórico local.

&amp;Configurações de operações

Auto-generated da @aws/agentcore v0.28.1 — não edite manualmente.

pausa do agentcore

agentcore pause [options] [command]

Pausar um recurso implantado (configuração de avaliação on-line, teste). A/B

currículo agentcore

agentcore resume [options] [command]

Retomar um recurso pausado (configuração de avaliação on-line, A/B teste).

parada do agentcore

agentcore stop [options] [command]

Interrompa uma avaliação ou A/B teste em lote em execução.

configuração do agentcore

agentcore config [options] [key] [value]

Ajuste as configurações globais, como o status de desativação da telemetria

Parâmetros

key

Chave de configuração em notação de ponto (por exemplo, telemetry.enabled)

value

Valor a ser definido

telemetria agentcore

agentcore telemetry [options] [command]

Gerencie as preferências anônimas de análise de uso.

feedback do agentcore

agentcore feedback [options] [message]

Envie feedback sobre a AgentCore CLI para a equipe.

Parâmetros

message

Mensagem de feedback [não interativa]

--screenshot <path> (opcional)

Caminho para uma captura de tela PNG ou JPG (máx. 100 MB) [não interativo]

--json (opcional)

Resultado de saída como JSON [não interativo]