Files
picoclaw/docs/guides/docker.pt-br.md
T
taonyx a36472b55f Add CLI support for custom OpenAI-compatible endpoints and remove TUI (#2710)
* feat(model): add `picoclaw model add` for custom OpenAI-compatible endpoints

Onboards a model from a user-supplied API base + key by hitting
GET <base>/models, prompting the user to pick one, and writing the entry
into model_list[] (with api_keys) plus setting it as the default model.
This was previously only available in the TUI launcher (issue #2208) and
is now accessible from the CLI:

    picoclaw model add -b URL -k KEY [-m MODEL] [-n ALIAS]

* chore: remove deprecated picoclaw-launcher-tui

Per RFC #2208, the TUI launcher is deprecated in favor of the CLI; its
"online model picker" feature has been ported to `picoclaw model add` in
the previous commit. This drops the binary and all build/release/docs
references:

- delete cmd/picoclaw-launcher-tui/ and assets/launcher-tui.jpg
- Makefile: remove the `build-launcher-tui` target
- .goreleaser.yaml: drop the build entry plus the `picoclaw-launcher-tui`
  ids from the launcher docker image, macOS notarize list, and nfpms
  contents
- docker/Dockerfile.goreleaser.launcher: drop the COPY for the TUI binary
- READMEs (root + 8 locales): remove the "TUI Launcher" section and
  screenshot link
- docs/guides/docker.*: update the "launcher image includes …" sentence
  to reflect the two remaining binaries

`make build` still succeeds; `go build ./web/backend` (the launcher
target) still succeeds. `picoclaw-launcher` (web console) is unaffected.
2026-04-29 17:52:47 +08:00

5.5 KiB

🐳 Docker e Início Rápido

Voltar ao README

🐳 Docker Compose

Você também pode executar o PicoClaw usando Docker Compose sem instalar nada localmente.

# 1. Clone este repositório
git clone https://github.com/sipeed/picoclaw.git
cd picoclaw

# 2. Primeira execução — gera automaticamente docker/data/config.json e encerra
#    (só é acionado quando config.json e workspace/ estão ambos ausentes)
docker compose -f docker/docker-compose.yml --profile gateway up
# O contêiner exibe "First-run setup complete." e para.

# 3. Configure suas chaves de API
vim docker/data/config.json   # Set provider API keys, bot tokens, etc.

# 4. Iniciar
docker compose -f docker/docker-compose.yml --profile gateway up -d

Tip

Usuários Docker: Por padrão, o Gateway escuta em 127.0.0.1, que não é acessível a partir do host. Se você precisar acessar os endpoints de saúde ou expor portas, defina PICOCLAW_GATEWAY_HOST=0.0.0.0 no seu ambiente ou atualize o config.json.

# 5. Verificar logs
docker compose -f docker/docker-compose.yml logs -f picoclaw-gateway

# 6. Parar
docker compose -f docker/docker-compose.yml --profile gateway down

Modo Launcher (Console Web)

A imagem launcher inclui ambos os binários (picoclaw, picoclaw-launcher) e inicia o console web por padrão, que fornece uma interface baseada em navegador para configuração e chat.

docker compose -f docker/docker-compose.yml --profile launcher up -d

Abra http://localhost:18800 no seu navegador. O launcher gerencia o processo do gateway automaticamente.

Warning

O console web é protegido por senha de login do dashboard. Não exponha o launcher a redes não confiáveis nem à internet pública.

Modo Agent (One-shot)

# Fazer uma pergunta
docker compose -f docker/docker-compose.yml run --rm picoclaw-agent -m "What is 2+2?"

# Modo interativo
docker compose -f docker/docker-compose.yml run --rm picoclaw-agent

Atualização

docker compose -f docker/docker-compose.yml pull
docker compose -f docker/docker-compose.yml --profile gateway up -d

🚀 Início Rápido

Tip

Configure sua chave de API em ~/.picoclaw/config.json. Obtenha chaves de API: Volcengine (CodingPlan) (LLM) · OpenRouter (LLM) · Zhipu (LLM). A busca na web é opcional — obtenha gratuitamente uma API Tavily (1000 consultas gratuitas/mês) ou API Brave Search (2000 consultas gratuitas/mês).

1. Inicializar

picoclaw onboard

2. Configurar (~/.picoclaw/config.json)

{
  "agents": {
    "defaults": {
      "workspace": "~/.picoclaw/workspace",
      "model_name": "gpt-5.4",
      "max_tokens": 8192,
      "temperature": 0.7,
      "max_tool_iterations": 20
    }
  },
  "model_list": [
    {
      "model_name": "ark-code-latest",
      "model": "volcengine/ark-code-latest",
      "api_keys": ["sk-your-api-key"],
      "api_base":"https://ark.cn-beijing.volces.com/api/coding/v3"
    },
    {
      "model_name": "gpt-5.4",
      "model": "openai/gpt-5.4",
      "api_keys": ["your-api-key"],
      "request_timeout": 300
    },
    {
      "model_name": "claude-sonnet-4.6",
      "model": "anthropic/claude-sonnet-4.6",
      "api_keys": ["your-anthropic-key"]
    }
  ],
  "tools": {
    "web": {
      "enabled": true,
      "fetch_limit_bytes": 10485760,
      "format": "plaintext",
      "brave": {
        "enabled": false,
        "api_key": "YOUR_BRAVE_API_KEY",
        "max_results": 5
      },
      "tavily": {
        "enabled": false,
        "api_key": "YOUR_TAVILY_API_KEY",
        "max_results": 5
      },
      "duckduckgo": {
        "enabled": true,
        "max_results": 5
      },
      "perplexity": {
        "enabled": false,
        "api_key": "YOUR_PERPLEXITY_API_KEY",
        "max_results": 5
      },
      "searxng": {
        "enabled": false,
        "base_url": "http://your-searxng-instance:8888",
        "max_results": 5
      }
    }
  }
}

Novo: O formato de configuração model_list permite adicionar provedores sem alteração de código. Veja Configuração de Modelos para detalhes. request_timeout é opcional e usa segundos. Se omitido ou definido como <= 0, o PicoClaw usa o timeout padrão (120s).

3. Obter chaves de API

  • Provedor LLM: OpenRouter · Zhipu · Anthropic · OpenAI · Gemini
  • Busca na Web (opcional):
    • Brave Search - Pago ($5/1000 consultas, ~$5-6/mês)
    • Perplexity - Busca com IA e interface de chat
    • SearXNG - Metabuscador auto-hospedado (gratuito, sem necessidade de chave de API)
    • Tavily - Otimizado para agentes de IA (1000 requisições/mês)
    • DuckDuckGo - Fallback integrado (sem necessidade de chave de API)

Nota: Veja config.example.json para um modelo de configuração completo.

4. Conversar

picoclaw agent -m "What is 2+2?"

Pronto! Você tem um assistente de IA funcionando em 2 minutos.