File size: 23,915 Bytes
3e05655 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 | ---
title: CLI
description: Opções e comandos da CLI do opencode.
---
import { Tabs, TabItem } from "@astrojs/starlight/components"
A CLI do opencode, por padrão, inicia o [TUI](/docs/tui) quando executada sem argumentos.
```bash
opencode
```
Mas também aceita comandos conforme documentado nesta página. Isso permite que você interaja com o opencode programaticamente.
```bash
opencode run "Explain how closures work in JavaScript"
```
---
### tui
Inicie a interface de usuário do terminal do opencode.
```bash
opencode [project]
```
#### Opções
| Flag | Curto | Descrição |
| ---------------------------------------- | ----- | -------------------------------------------------------------------------- |
| <nobr><code>{"--continue"}</code></nobr> | `-c` | Continue a última sessão |
| <nobr><code>{"--session"}</code></nobr> | `-s` | ID da sessão para continuar |
| <nobr><code>{"--fork"}</code></nobr> | | Criar um fork da sessão ao continuar (use com `--continue` ou `--session`) |
| <nobr><code>{"--prompt"}</code></nobr> | | Prompt a ser usado |
| <nobr><code>{"--model"}</code></nobr> | `-m` | Modelo a ser usado na forma de provider/model |
| <nobr><code>{"--agent"}</code></nobr> | | Agente a ser usado |
| <nobr><code>{"--port"}</code></nobr> | | Porta para escutar |
| <nobr><code>{"--hostname"}</code></nobr> | | Nome do host para escutar |
---
## Comandos
A CLI do opencode também possui os seguintes comandos.
---
### agent
Gerencie agentes para o opencode.
```bash
opencode agent [command]
```
---
### attach
Anexe um terminal a um servidor backend do opencode já em execução, iniciado via comandos `serve` ou `web`.
```bash
opencode attach [url]
```
Isso permite usar o TUI com um backend opencode remoto. Por exemplo:
```bash
# Inicie o servidor backend para acesso web/mobile
opencode web --port 4096 --hostname 0.0.0.0
# Em outro terminal, anexe o TUI ao backend em execução
opencode attach http://10.20.30.40:4096
```
#### Opções
| Flag | Curto | Descrição |
| ---------------------------------------- | ----- | --------------------------------------------------------------------------------- |
| <nobr><code>{"--dir"}</code></nobr> | | Diretório de trabalho para iniciar o TUI |
| <nobr><code>{"--continue"}</code></nobr> | `-c` | Continuar a última sessão |
| <nobr><code>{"--session"}</code></nobr> | `-s` | ID da sessão para continuar |
| <nobr><code>{"--fork"}</code></nobr> | | Bifurcar a sessão ao continuar (use com `--continue` ou `--session`) |
| <nobr><code>{"--password"}</code></nobr> | `-p` | Senha de autenticação básica (padrão: `OPENCODE_SERVER_PASSWORD`) |
| <nobr><code>{"--username"}</code></nobr> | `-u` | Usuário de autenticação básica (padrão: `OPENCODE_SERVER_USERNAME` ou `opencode`) |
---
#### create
Crie um novo agente com configuração personalizada.
```bash
opencode agent create
```
Este comando irá guiá-lo na criação de um novo agente com um prompt de sistema personalizado e configuração de ferramentas.
---
#### list
Liste todos os agentes disponíveis.
```bash
opencode agent list
```
---
### auth
Comando para gerenciar credenciais e login para provedores.
```bash
opencode auth [command]
```
---
#### login
O opencode é alimentado pela lista de provedores em [Models.dev](https://models.dev), então você pode usar `opencode auth login` para configurar chaves de API para qualquer provedor que você gostaria de usar. Isso é armazenado em `~/.local/share/opencode/auth.json`.
```bash
opencode auth login
```
Quando o opencode é iniciado, ele carrega os provedores do arquivo de credenciais. E se houver chaves definidas em seus ambientes ou em um arquivo `.env` em seu projeto.
---
#### list
Lista todos os provedores autenticados conforme armazenado no arquivo de credenciais.
```bash
opencode auth list
```
Ou a versão curta.
```bash
opencode auth ls
```
---
#### logout
Desconecta você de um provedor limpando-o do arquivo de credenciais.
```bash
opencode auth logout
```
---
### github
Gerencie o agente do GitHub para automação de repositórios.
```bash
opencode github [command]
```
---
#### install
Instale o agente do GitHub em seu repositório.
```bash
opencode github install
```
Isso configura o fluxo de trabalho necessário do GitHub Actions e o guia pelo processo de configuração. [Saiba mais](/docs/github).
---
#### run
Execute o agente do GitHub. Isso é tipicamente usado em GitHub Actions.
```bash
opencode github run
```
##### Opções
| Flag | Descrição |
| ------------------------------------- | ------------------------------------------------ |
| <nobr><code>{"--event"}</code></nobr> | Evento simulado do GitHub para executar o agente |
| <nobr><code>{"--token"}</code></nobr> | Token de acesso pessoal do GitHub |
---
### mcp
Gerencie servidores do Model Context Protocol.
```bash
opencode mcp [command]
```
---
#### add
Adicione um servidor MCP à sua configuração.
```bash
opencode mcp add
```
Este comando irá guiá-lo na adição de um servidor MCP local ou remoto.
---
#### list
Liste todos os servidores MCP configurados e seu status de conexão.
```bash
opencode mcp list
```
Ou use a versão curta.
```bash
opencode mcp ls
```
---
#### auth
Autentique-se com um servidor MCP habilitado para OAuth.
```bash
opencode mcp auth [name]
```
Se você não fornecer um nome de servidor, será solicitado que você selecione entre os servidores disponíveis habilitados para OAuth.
Você também pode listar servidores habilitados para OAuth e seu status de autenticação.
```bash
opencode mcp auth list
```
Ou use a versão curta.
```bash
opencode mcp auth ls
```
---
#### logout
Remova credenciais OAuth para um servidor MCP.
```bash
opencode mcp logout [name]
```
---
#### debug
Depure problemas de conexão OAuth para um servidor MCP.
```bash
opencode mcp debug <name>
```
---
### models
Liste todos os modelos disponíveis dos provedores configurados.
```bash
opencode models [provider]
```
Este comando exibe todos os modelos disponíveis entre seus provedores configurados no formato `provider/model`.
Isso é útil para descobrir o nome exato do modelo a ser usado em [sua configuração](/docs/config/).
Você pode opcionalmente passar um ID de provedor para filtrar modelos por esse provedor.
```bash
opencode models anthropic
```
#### Opções
| Flag | Descrição |
| --------------------------------------- | --------------------------------------------------------------------- |
| <nobr><code>{"--refresh"}</code></nobr> | Atualiza o cache de modelos a partir do models.dev |
| <nobr><code>{"--verbose"}</code></nobr> | Use uma saída de modelo mais detalhada (inclui metadados como custos) |
Use a flag `--refresh` para atualizar a lista de modelos em cache. Isso é útil quando novos modelos foram adicionados a um provedor e você deseja vê-los no opencode.
```bash
opencode models --refresh
```
---
### run
Execute o opencode em modo não interativo passando um prompt diretamente.
```bash
opencode run [message..]
```
Isso é útil para scripts, automação ou quando você deseja uma resposta rápida sem iniciar o TUI completo. Por exemplo.
```bash "opencode run"
opencode run Explique o uso de context em Go
```
Você também pode se anexar a uma instância em execução do `opencode serve` para evitar tempos de inicialização a frio do servidor MCP em cada execução:
```bash
# Inicie um servidor sem cabeça em um terminal
opencode serve
# Em outro terminal, execute comandos que se anexam a ele
opencode run --attach http://localhost:4096 "Explique async/await em JavaScript"
```
#### Opções
| Flag | Curto | Descrição |
| ---------------------------------------- | ----- | --------------------------------------------------------------------------------- |
| <nobr><code>{"--command"}</code></nobr> | | O comando a ser executado, use mensagem para argumentos |
| <nobr><code>{"--continue"}</code></nobr> | `-c` | Continue a última sessão |
| <nobr><code>{"--session"}</code></nobr> | `-s` | ID da sessão para continuar |
| <nobr><code>{"--fork"}</code></nobr> | | Criar um fork da sessão ao continuar (use com `--continue` ou `--session`) |
| <nobr><code>{"--share"}</code></nobr> | | Compartilhe a sessão |
| <nobr><code>{"--model"}</code></nobr> | `-m` | Modelo a ser usado na forma de provider/model |
| <nobr><code>{"--agent"}</code></nobr> | | Agente a ser usado |
| <nobr><code>{"--file"}</code></nobr> | `-f` | Arquivo(s) a serem anexados à mensagem |
| <nobr><code>{"--format"}</code></nobr> | | Formato: padrão (formatado) ou json (eventos JSON brutos) |
| <nobr><code>{"--title"}</code></nobr> | | Título para a sessão (usa o prompt truncado se nenhum valor for fornecido) |
| <nobr><code>{"--attach"}</code></nobr> | | Anexe a um servidor opencode em execução (por exemplo, http://localhost:4096) |
| <nobr><code>{"--password"}</code></nobr> | `-p` | Senha de autenticação básica (padrão: `OPENCODE_SERVER_PASSWORD`) |
| <nobr><code>{"--username"}</code></nobr> | `-u` | Usuário de autenticação básica (padrão: `OPENCODE_SERVER_USERNAME` ou `opencode`) |
| <nobr><code>{"--dir"}</code></nobr> | | Diretório de execução, ou caminho no servidor remoto ao anexar |
| <nobr><code>{"--variant"}</code></nobr> | | Variante do modelo (nível de raciocínio específico do provedor) |
| <nobr><code>{"--thinking"}</code></nobr> | | Mostrar blocos de pensamento |
| <nobr><code>{"--port"}</code></nobr> | | Porta para o servidor local (padrão para porta aleatória) |
---
### serve
Inicie um servidor opencode sem cabeça para acesso à API. Confira a [documentação do servidor](/docs/server) para a interface HTTP completa.
```bash
opencode serve
```
Isso inicia um servidor HTTP que fornece acesso à funcionalidade do opencode sem a interface TUI. Defina `OPENCODE_SERVER_PASSWORD` para habilitar a autenticação básica HTTP (o nome de usuário padrão é `opencode`).
#### Opções
| Flag | Descrição |
| ---------------------------------------- | ----------------------------------------------------- |
| <nobr><code>{"--port"}</code></nobr> | Porta para escutar |
| <nobr><code>{"--hostname"}</code></nobr> | Nome do host para escutar |
| <nobr><code>{"--mdns"}</code></nobr> | Habilitar descoberta mDNS |
| <nobr><code>{"--cors"}</code></nobr> | Origem(ns) de navegador adicionais para permitir CORS |
---
### session
Gerencie sessões do opencode.
```bash
opencode session [command]
```
---
#### list
Liste todas as sessões do opencode.
```bash
opencode session list
```
##### Opções
| Flag | Curto | Descrição |
| ----------------------------------------- | ----- | ----------------------------------------- |
| <nobr><code>{"--max-count"}</code></nobr> | `-n` | Limitar às N sessões mais recentes |
| <nobr><code>{"--format"}</code></nobr> | | Formato de saída: tabela ou json (tabela) |
---
### stats
Mostre o uso de tokens e estatísticas de custo para suas sessões do opencode.
```bash
opencode stats
```
#### Opções
| Flag | Descrição |
| --------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| <nobr><code>{"--days"}</code></nobr> | Mostre estatísticas dos últimos N dias (todo o tempo) |
| <nobr><code>{"--tools"}</code></nobr> | Número de ferramentas a serem mostradas (todas) |
| <nobr><code>{"--models"}</code></nobr> | Mostre a divisão do uso de modelos (oculto por padrão). Passe um número para mostrar os N principais |
| <nobr><code>{"--project"}</code></nobr> | Filtrar por projeto (todos os projetos, string vazia: projeto atual) |
---
### export
Exporte dados da sessão como JSON.
```bash
opencode export [sessionID]
```
Se você não fornecer um ID de sessão, será solicitado que você selecione entre as sessões disponíveis.
---
### import
Importe dados da sessão de um arquivo JSON ou URL de compartilhamento do opencode.
```bash
opencode import <file>
```
Você pode importar de um arquivo local ou de uma URL de compartilhamento do opencode.
```bash
opencode import session.json
opencode import https://opncd.ai/s/abc123
```
---
### web
Inicie um servidor opencode sem cabeça com uma interface web.
```bash
opencode web
```
Isso inicia um servidor HTTP e abre um navegador para acessar o opencode através de uma interface web. Defina `OPENCODE_SERVER_PASSWORD` para habilitar a autenticação básica HTTP (o nome de usuário padrão é `opencode`).
#### Opções
| Flag | Descrição |
| ---------------------------------------- | ----------------------------------------------------- |
| <nobr><code>{"--port"}</code></nobr> | Porta para escutar |
| <nobr><code>{"--hostname"}</code></nobr> | Nome do host para escutar |
| <nobr><code>{"--mdns"}</code></nobr> | Habilitar descoberta mDNS |
| <nobr><code>{"--cors"}</code></nobr> | Origem(ns) de navegador adicionais para permitir CORS |
---
### acp
Inicie um servidor ACP (Agent Client Protocol).
```bash
opencode acp
```
Este comando inicia um servidor ACP que se comunica via stdin/stdout usando nd-JSON.
#### Opções
| Flag | Descrição |
| ---------------------------------------- | ------------------------- |
| <nobr><code>{"--cwd"}</code></nobr> | Diretório de trabalho |
| <nobr><code>{"--port"}</code></nobr> | Porta para escutar |
| <nobr><code>{"--hostname"}</code></nobr> | Nome do host para escutar |
---
### uninstall
Desinstale o opencode e remova todos os arquivos relacionados.
```bash
opencode uninstall
```
#### Opções
| Flag | Curto | Descrição |
| ------------------------------------------- | ----- | ---------------------------------------- |
| <nobr><code>{"--keep-config"}</code></nobr> | `-c` | Manter arquivos de configuração |
| <nobr><code>{"--keep-data"}</code></nobr> | `-d` | Manter dados de sessão e snapshots |
| <nobr><code>{"--dry-run"}</code></nobr> | | Mostrar o que seria removido sem remover |
| <nobr><code>{"--force"}</code></nobr> | `-f` | Pular prompts de confirmação |
---
### upgrade
Atualiza o opencode para a versão mais recente ou uma versão específica.
```bash
opencode upgrade [target]
```
Para atualizar para a versão mais recente.
```bash
opencode upgrade
```
Para atualizar para uma versão específica.
```bash
opencode upgrade v0.1.48
```
#### Opções
| Flag | Curto | Descrição |
| -------------------------------------- | ----- | ---------------------------------------------------------------- |
| <nobr><code>{"--method"}</code></nobr> | `-m` | O método de instalação que foi usado; curl, npm, pnpm, bun, brew |
---
## Opções Globais
A CLI do opencode aceita as seguintes flags globais.
| Flag | Curto | Descrição |
| ------------------------------------------ | ----- | --------------------------------------- |
| <nobr><code>{"--help"}</code></nobr> | `-h` | Exibir ajuda |
| <nobr><code>{"--version"}</code></nobr> | `-v` | Imprimir número da versão |
| <nobr><code>{"--print-logs"}</code></nobr> | | Imprimir logs no stderr |
| <nobr><code>{"--log-level"}</code></nobr> | | Nível de log (DEBUG, INFO, WARN, ERROR) |
---
## Variáveis de ambiente
O opencode pode ser configurado usando variáveis de ambiente.
| Variável | Tipo | Descrição |
| ------------------------------------- | ------- | --------------------------------------------------------------------- |
| `OPENCODE_AUTO_SHARE` | boolean | Compartilhar sessões automaticamente |
| `OPENCODE_GIT_BASH_PATH` | string | Caminho para o executável do Git Bash no Windows |
| `OPENCODE_CONFIG` | string | Caminho para o arquivo de configuração |
| `OPENCODE_CONFIG_DIR` | string | Caminho para o diretório de configuração |
| `OPENCODE_CONFIG_CONTENT` | string | Conteúdo de configuração json inline |
| `OPENCODE_DISABLE_AUTOUPDATE` | boolean | Desabilitar verificações de atualização automática |
| `OPENCODE_DISABLE_PRUNE` | boolean | Desabilitar a poda de dados antigos |
| `OPENCODE_DISABLE_TERMINAL_TITLE` | boolean | Desabilitar atualizações automáticas do título do terminal |
| `OPENCODE_PERMISSION` | string | Configuração de permissões json inline |
| `OPENCODE_DISABLE_DEFAULT_PLUGINS` | boolean | Desabilitar plugins padrão |
| `OPENCODE_DISABLE_LSP_DOWNLOAD` | boolean | Desabilitar downloads automáticos do servidor LSP |
| `OPENCODE_ENABLE_EXPERIMENTAL_MODELS` | boolean | Habilitar modelos experimentais |
| `OPENCODE_DISABLE_AUTOCOMPACT` | boolean | Desabilitar compactação automática de contexto |
| `OPENCODE_DISABLE_CLAUDE_CODE` | boolean | Desabilitar leitura de `.claude` (prompt + habilidades) |
| `OPENCODE_DISABLE_CLAUDE_CODE_PROMPT` | boolean | Desabilitar leitura de `~/.claude/CLAUDE.md` |
| `OPENCODE_DISABLE_CLAUDE_CODE_SKILLS` | boolean | Desabilitar carregamento de `.claude/skills` |
| `OPENCODE_DISABLE_MODELS_FETCH` | boolean | Desabilitar busca de modelos de fontes remotas |
| `OPENCODE_FAKE_VCS` | string | Provedor VCS falso para fins de teste |
| `OPENCODE_CLIENT` | string | Identificador do cliente (padrão é `cli`) |
| `OPENCODE_ENABLE_EXA` | boolean | Habilitar ferramentas de busca web Exa |
| `OPENCODE_SERVER_PASSWORD` | string | Habilitar autenticação básica para `serve`/`web` |
| `OPENCODE_SERVER_USERNAME` | string | Substituir nome de usuário de autenticação básica (padrão `opencode`) |
| `OPENCODE_MODELS_URL` | string | URL personalizada para buscar configuração de modelos |
---
### Experimental
Essas variáveis de ambiente habilitam recursos experimentais que podem mudar ou ser removidos.
| Variável | Tipo | Descrição |
| ----------------------------------------------- | ------- | --------------------------------------------------------- |
| `OPENCODE_EXPERIMENTAL` | boolean | Habilitar recursos experimentais sob o sinalizador global |
| `OPENCODE_EXPERIMENTAL_ICON_DISCOVERY` | boolean | Habilitar descoberta de ícones |
| `OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT` | boolean | Desabilitar cópia ao selecionar no TUI |
| `OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS` | number | Tempo limite padrão para comandos bash em ms |
| `OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAX` | number | Máximo de tokens de saída para respostas LLM |
| `OPENCODE_EXPERIMENTAL_FILEWATCHER` | boolean | Habilitar monitoramento de arquivos para todo o diretório |
| `OPENCODE_EXPERIMENTAL_OXFMT` | boolean | Habilitar formatador oxfmt |
| `OPENCODE_EXPERIMENTAL_LSP_TOOL` | boolean | Habilitar ferramenta LSP experimental |
| `OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHER` | boolean | Desabilitar monitoramento de arquivos |
| `OPENCODE_EXPERIMENTAL_EXA` | boolean | Habilitar recursos experimentais do Exa |
| `OPENCODE_EXPERIMENTAL_LSP_TY` | boolean | Habilitar TY LSP para arquivos python |
| `OPENCODE_EXPERIMENTAL_PLAN_MODE` | boolean | Habilitar modo de plano |
| `OPENCODE_EXPERIMENTAL_BACKGROUND_SUBAGENTS` | boolean | Habilitar tarefas de subagentes em segundo plano |
| `OPENCODE_EXPERIMENTAL_EVENT_SYSTEM` | boolean | Habilitar sistema de eventos experimental |
| `OPENCODE_EXPERIMENTAL_NATIVE_LLM` | boolean | Habilitar caminho nativo de requisição LLM |
| `OPENCODE_EXPERIMENTAL_PARALLEL` | boolean | Habilitar execução paralela de busca web |
| `OPENCODE_EXPERIMENTAL_SCOUT` | boolean | Habilitar subagente Scout |
| `OPENCODE_EXPERIMENTAL_WORKSPACES` | boolean | Habilitar suporte a espaços de trabalho |
|