OpenClawDocs
View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this page

Guides

Automação da CLI

Use openclaw onboard --non-interactive para automatizar a configuração por script. Ele exige --accept-risk: a configuração não interativa pode gravar credenciais e a configuração do daemon sem uma solicitação de confirmação, portanto essa opção representa o reconhecimento explícito do risco.

Exemplo básico não interativo

bash
openclaw onboard --non-interactive --accept-risk \  --mode local \  --auth-choice apiKey \  --anthropic-api-key "$ANTHROPIC_API_KEY" \  --secret-input-mode plaintext \  --gateway-bind loopback \  --install-daemon \  --daemon-runtime node \  --skip-bootstrap \  --skip-skills

Adicione --json para obter um resumo legível por máquina.

  • O valor padrão de --gateway-port é 18789; passe essa opção somente para substituí-lo.
  • --skip-bootstrap ignora a criação dos arquivos padrão do espaço de trabalho, para automações que preenchem previamente o próprio espaço de trabalho.
  • --secret-input-mode ref armazena no perfil de autenticação uma referência baseada em variável de ambiente ({ source: "env", provider: "default", id: "<ENV_VAR>" }), em vez da chave em texto simples. No modo ref não interativo, a variável de ambiente do provedor já deve estar definida no ambiente do processo: passar uma opção de chave diretamente sem a variável de ambiente correspondente causa uma falha imediata.
bash
openclaw onboard --non-interactive --accept-risk \  --mode local \  --auth-choice openai-api-key \  --secret-input-mode ref

Exemplos específicos de provedores

Exemplo com chave de API da Anthropic
bash
openclaw onboard --non-interactive --accept-risk \  --mode local \  --auth-choice apiKey \  --anthropic-api-key "$ANTHROPIC_API_KEY" \  --gateway-bind loopback
Exemplo com o Cloudflare AI Gateway
bash
openclaw onboard --non-interactive --accept-risk \  --mode local \  --auth-choice cloudflare-ai-gateway-api-key \  --cloudflare-ai-gateway-account-id "your-account-id" \  --cloudflare-ai-gateway-gateway-id "your-gateway-id" \  --cloudflare-ai-gateway-api-key "$CLOUDFLARE_AI_GATEWAY_API_KEY" \  --gateway-bind loopback
Exemplo com o Gemini
bash
openclaw onboard --non-interactive --accept-risk \  --mode local \  --auth-choice gemini-api-key \  --gemini-api-key "$GEMINI_API_KEY" \  --gateway-bind loopback
Exemplo com o Mistral
bash
openclaw onboard --non-interactive --accept-risk \  --mode local \  --auth-choice mistral-api-key \  --mistral-api-key "$MISTRAL_API_KEY" \  --gateway-bind loopback
Exemplo com o Moonshot
bash
openclaw onboard --non-interactive --accept-risk \  --mode local \  --auth-choice moonshot-api-key \  --moonshot-api-key "$MOONSHOT_API_KEY" \  --gateway-bind loopback
Exemplo com o Ollama
bash
openclaw onboard --non-interactive --accept-risk \  --mode local \  --auth-choice ollama \  --custom-model-id "qwen3.5:27b" \  --gateway-bind loopback
Exemplo com o OpenCode
bash
openclaw onboard --non-interactive --accept-risk \  --mode local \  --auth-choice opencode-zen \  --opencode-zen-api-key "$OPENCODE_API_KEY" \  --gateway-bind loopback

Substitua por --auth-choice opencode-go --opencode-go-api-key "$OPENCODE_API_KEY" para usar o catálogo Go.

Exemplo com o Synthetic
bash
openclaw onboard --non-interactive --accept-risk \  --mode local \  --auth-choice synthetic-api-key \  --synthetic-api-key "$SYNTHETIC_API_KEY" \  --gateway-bind loopback
Exemplo com o Vercel AI Gateway
bash
openclaw onboard --non-interactive --accept-risk \  --mode local \  --auth-choice ai-gateway-api-key \  --ai-gateway-api-key "$AI_GATEWAY_API_KEY" \  --gateway-bind loopback
Exemplo com o Z.AI
bash
openclaw onboard --non-interactive --accept-risk \  --mode local \  --auth-choice zai-api-key \  --zai-api-key "$ZAI_API_KEY" \  --gateway-bind loopback
Exemplo com um provedor personalizado
bash
openclaw onboard --non-interactive --accept-risk \  --mode local \  --auth-choice custom-api-key \  --custom-base-url "https://llm.example.com/v1" \  --custom-model-id "foo-large" \  --custom-api-key "$CUSTOM_API_KEY" \  --custom-provider-id "my-custom" \  --custom-compatibility anthropic \  --custom-image-input \  --gateway-bind loopback

--custom-api-key é opcional; alguns endpoints não exigem autenticação. Quando omitida, a integração inicial verifica CUSTOM_API_KEY no ambiente. --custom-provider-id é opcional e, quando omitida, é derivada automaticamente da URL base. O valor padrão de --custom-compatibility é openai (outros valores: openai-responses, anthropic).

O OpenClaw infere a compatibilidade com entrada de imagens a partir de padrões conhecidos de IDs de modelos de visão (gpt-4o, claude-3/4, gemini, sufixos -vl/vision e semelhantes). Adicione --custom-image-input para ativá-la à força em um modelo de visão não reconhecido ou --custom-text-input para forçar o uso exclusivo de texto.

Variante do modo ref, que armazena apiKey como { source: "env", provider: "default", id: "CUSTOM_API_KEY" }:

bash
export CUSTOM_API_KEY="your-key"openclaw onboard --non-interactive --accept-risk \  --mode local \  --auth-choice custom-api-key \  --custom-base-url "https://llm.example.com/v1" \  --custom-model-id "foo-large" \  --secret-input-mode ref \  --custom-provider-id "my-custom" \  --custom-compatibility anthropic \  --custom-image-input \  --gateway-bind loopback

A autenticação por token de configuração da Anthropic continua compatível, mas o OpenClaw prefere reutilizar a Claude CLI quando há uma sessão local disponível nela. Para produção, prefira uma chave de API da Anthropic.

Adicionar outro agente

openclaw agents add <name> cria um agente separado com espaço de trabalho, sessões e perfis de autenticação próprios. Executá-lo sem --workspace (e sem nenhuma outra opção) inicia o assistente interativo; passar qualquer uma das opções --workspace, --model, --agent-dir, --bind ou --non-interactive o executa de forma não interativa e, nesse caso, exige --workspace.

bash
openclaw agents add work \  --workspace ~/.openclaw/workspace-work \  --model openai/gpt-5.6-sol \  --bind whatsapp:biz \  --non-interactive \  --json

Chaves de configuração gravadas pelo comando (entrada em agents.list[] para o ID do novo agente):

  • name
  • workspace
  • agentDir
  • model (somente quando --model é passada)

Observações:

  • Espaço de trabalho padrão (quando --workspace é omitida no assistente interativo): ~/.openclaw/workspace-<agentId>.
  • --bind <channel[:accountId]> pode ser repetida; adicione associações para encaminhar mensagens recebidas ao novo agente (o assistente também permite fazer isso de forma interativa).
  • O nome do agente é normalizado para um ID de agente válido; main é reservado.

Documentação relacionada

Was this useful?
On this page

On this page