CLI
Parâmetros
Opções globais
As opções globais podem ser usadas com qualquer comando:
| Opção | Descrição |
|---|---|
-v, --version | Exibe o número da versão |
--api-key <key> | Chave de API para autenticação (também é possível usar a variável de ambiente CURSOR_API_KEY) |
-H, --header <header> | Adiciona um cabeçalho personalizado às solicitações do agente (formato: Nome: Valor; pode ser usado várias vezes) |
-p, --print | Imprime as respostas no console (para scripts ou uso não interativo). Tem acesso a todas as ferramentas, incluindo escrita e shell. |
--output-format <format> | Formato de saída (funciona apenas com --print): text, json ou stream-json (padrão: text) |
--stream-partial-output | Transmite saída parcial como deltas de texto individuais (funciona apenas com --print e o formato stream-json) |
--resume [chatId] | Retoma uma sessão de chat |
--continue | Continua a sessão anterior (alias de --resume=-1) |
--model <model> | Modelo a usar |
--mode <mode> | Define o modo do agente: plan ou ask (o modo agente é o padrão quando nenhum modo é especificado) |
--plan | Inicia no modo Plan (abreviação de --mode=plan) |
--list-models | Lista todos os modelos disponíveis |
-f, --force | Permite comandos à força, exceto quando explicitamente negados |
--yolo | Alias de --force |
--sandbox <mode> | Define o modo sandbox: enabled ou disabled |
--approve-mcps | Aprova automaticamente todos os servidores MCP |
--trust | Confia no espaço de trabalho sem solicitar confirmação (somente no modo sem interface gráfica) |
--workspace <path> | Diretório do espaço de trabalho a usar |
--plugin-dir <path> | Carrega um diretório de plugin local (pode ser especificado várias vezes) |
-w, --worktree [name] | Executa em uma nova worktree do Git em ~/.cursor/worktrees/<reponame>/<name>. Se omitido, um nome é gerado. |
--worktree-base <branch> | Branch ou ref na qual basear a nova worktree (padrão: HEAD atual) |
--skip-worktree-setup | Ignora a execução dos scripts de configuração da worktree em .cursor/worktrees.json |
-h, --help | Exibe a ajuda do comando |
Comandos
| Comando | Descrição | Uso |
|---|---|---|
agent [prompt...] | Iniciar no modo agente (padrão) | agent agent "fix the tests" |
login | Autenticar-se no Cherri Code | agent login |
logout | Sair e limpar a autenticação armazenada | agent logout |
status | whoami | Ver o status da autenticação |
about | Exibir informações sobre versão, sistema e conta | agent about |
models | Listar os modelos disponíveis para esta conta | agent models |
mcp | Gerenciar servidores MCP | agent mcp |
sandbox | Configurar o modo sandbox ou executar um comando em um sandbox (oculto) | agent sandbox enable |
worker | Iniciar um worker de nuvem privada que executa agentes no seu ambiente | agent worker start |
acp | Iniciar o modo de servidor ACP (comando avançado e oculto) | agent acp |
update | Atualizar o Cherri Code Agent para a versão mais recente | agent update |
ls | Retomar uma sessão de chat | agent ls |
resume | Retomar a sessão de chat mais recente | agent resume |
create-chat | Criar um novo chat vazio e retornar seu ID | agent create-chat |
generate-rule | rule | Gerar uma nova regra do Cherri Code com prompts interativos |
install-shell-integration | Instalar a integração de shell em ~/.zshrc | agent install-shell-integration |
uninstall-shell-integration | Remover a integração de shell de ~/.zshrc | agent uninstall-shell-integration |
help [command] | Exibir ajuda sobre o comando | agent help [command] |
agent acp destina-se a clientes ACP personalizados e integrações avançadas. Ele fica
oculto na saída de ajuda padrão dos comandos.
Quando nenhum comando é especificado, o Cherri Code Agent é iniciado por padrão no modo interativo de agente.
MCP
Gerencie os servidores MCP configurados no Cherri Code Agent.
| Subcomando | Descrição | Uso |
|---|---|---|
login <identifier> | Autentique-se em um servidor MCP configurado em .cursor/mcp.json ou ~/.cursor/mcp.json | agent mcp login <identifier> |
list | Liste os servidores MCP configurados e seus status | agent mcp list |
list-tools <identifier> | Liste as ferramentas disponíveis e os nomes dos argumentos de um MCP específico | agent mcp list-tools <identifier> |
enable <identifier> | Adicione um servidor MCP à lista local de servidores aprovados | agent mcp enable <identifier> |
disable <identifier> | Desative um servidor MCP para que ele não seja carregado nem solicite aprovação | agent mcp disable <identifier> |
Todos os comandos MCP oferecem suporte a -h, --help para ajuda específica do comando.
Sandbox
Configure o modo sandbox ou execute um comando em uma sandbox.
| Subcomando | Descrição | Uso |
|---|---|---|
enable | Ativa o modo sandbox para execução de comandos | agent sandbox enable |
disable | Desativa o modo sandbox e usa o modo de lista de permissão | agent sandbox disable |
reset | Restaura a configuração da sandbox aos valores padrão | agent sandbox reset |
run <cmd> [args...] | Executa um comando em uma sandbox com acesso de leitura/gravação ao espaço de trabalho | agent sandbox run ls |
help [command] | Exibe a ajuda do comando | agent sandbox help |
| Comando | Opção | Descrição |
|---|---|---|
sandbox run | --allow-paths <paths> | Lista de caminhos adicionais de leitura/gravação separados por vírgulas |
sandbox run | --readonly-paths <paths> | Lista de caminhos adicionais somente leitura separados por vírgulas |
sandbox run | --blocked-patterns <patterns> | Lista de padrões no estilo gitignore a bloquear, separados por vírgulas |
sandbox run | --sandbox | Executa com a política de sandbox de leitura/gravação do espaço de trabalho (padrão: true) |
sandbox run | --network | Ativa o acesso à rede na sandbox (padrão: false) |
sandbox run | --sb-debug | Grava logs de depuração da sandbox em uma pasta temporária e exibe o caminho |
Todos os comandos sandbox oferecem -h, --help para ajuda específica de cada comando.
Worker
Inicie um worker de nuvem privado que se conecta ao Cherri Code e executa agentes no seu ambiente.
| Subcomando | Descrição | Uso |
|---|---|---|
start | Inicie o worker e conecte-se ao Cherri Code | agent worker start |
debug | Execute diagnósticos de pré-verificação do worker privado para autenticação, privacidade e roteamento | agent worker debug |
help [command] | Exiba a ajuda do comando | agent worker help |
| Comando | Opção | Descrição |
|---|---|---|
worker | --auth-token-file <path> | Caminho para um arquivo que contém o token de autenticação do worker |
worker | --worker-dir <path> | Raiz do espaço de trabalho a ser exposta aos agentes. Pode ser repetida. O primeiro valor é a identidade de atribuição. |
worker | --management-addr <address> | Endereço de escuta de /healthz, /readyz e /metrics |
worker | --label <key=value> | Adicione um rótulo ao worker. Pode ser usado várias vezes. Não pode ser usado com --labels-file. |
worker | --labels-file <path> | Caminho para um arquivo de rótulos em JSON ou TOML. Também é possível usar CURSOR_WORKER_LABELS_FILE. |
worker | --idle-release-timeout <seconds> | Número de segundos que o worker pode permanecer conectado após ficar ocioso. O valor padrão 0 desativa a liberação por inatividade. |
worker | --pool | Registre-se para atribuição a um pool. Um agente em nuvem reivindica o worker por vez. |
worker | --single-use | Alias legado para --pool |
worker | --pool-name <name> | Rótulo do pool para workers do pool. Requer --pool ou --single-use. O valor padrão é default. |
worker | --name <name> | Nome de exibição personalizado. Por padrão, usa o hostname da máquina. |
worker | --data-dir <path> | Diretório base para logs, artefatos e dados de gravação |
worker | --debug | Exiba diagnósticos de depuração do worker antes de iniciar o modo ponte |
worker | --computer-use | Permita que os agentes controlem o desktop desta máquina. No macOS, instala o aplicativo auxiliar Cherri Code Computer Use se necessário. Consulte Computer use. |
worker | --display <display> | Somente Linux. Display X11 existente a ser exigido para --computer-use, por exemplo :0. |
worker | --share-desktop [mode] | Somente Linux. Permita que visualizadores autorizados assistam ou controlem o desktop do agente: view ou view_and_control. Independente do computer use. |
worker start | --verbose | Ative logs detalhados de inicialização |
worker debug | --json | Gere o relatório de depuração em JSON |
Opções específicas de cada comando
| Comando | Opção | Descrição |
|---|---|---|
status, whoami | --format <format> | Formato de saída: text ou json (padrão: text) |
about | --format <format> | Formato de saída: text ou json (padrão: text) |
Argumentos
Ao iniciar no modo de chat (comportamento padrão), você pode fornecer um prompt inicial:
Argumentos:
prompt— Prompt inicial para o agente
Como obter ajuda
Todos os comandos oferecem a opção global -h, --help para exibir ajuda específica do comando.