Справочник по настройке CLI

Эта страница является полным справочником по openclaw onboard. Краткое руководство см. в разделе Онбординг (CLI).

Что делает мастер

Локальный режим (по умолчанию) проводит вас через:

• Настройку модели и аутентификации (OAuth для подписки OpenAI Code, CLI или API-ключ Anthropic Claude, а также варианты MiniMax, GLM, Ollama, Moonshot, StepFun и AI Gateway)
• Расположение рабочей области и файлы начальной настройки
• Настройки Gateway (порт, привязка, аутентификация, Tailscale)
• Каналы и провайдеры (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, iMessage и другие встроенные Plugin каналов)
• Установку демона (LaunchAgent, пользовательский юнит systemd или нативная запланированная задача Windows с резервным вариантом через папку Startup)
• Проверку работоспособности
• Настройку Skills

Удаленный режим настраивает этот компьютер для подключения к Gateway в другом месте. Он не устанавливает и не изменяет ничего на удаленном хосте.

Подробности локального процесса

Подробности удаленного режима

Удаленный режим настраивает этот компьютер для подключения к Gateway в другом месте.

Что вы задаете:

• URL удаленного gateway (ws://...)
• Токен, если удаленному gateway требуется аутентификация (рекомендуется)

Варианты аутентификации и моделей

Поведение модели:

• Выберите модель по умолчанию из обнаруженных вариантов или введите провайдера и модель вручную.
• Онбординг пользовательского провайдера выводит поддержку изображений для распространенных ID моделей и спрашивает только тогда, когда имя модели неизвестно.
• Когда онбординг начинается с выбора аутентификации провайдера, средство выбора модели автоматически предпочитает этого провайдера. Для Volcengine и BytePlus то же предпочтение также соответствует их вариантам coding-plan (volcengine-plan/*, byteplus-plan/*).
• Если этот фильтр предпочитаемого провайдера оказался бы пустым, средство выбора откатывается к полному каталогу вместо показа отсутствия моделей.
• Мастер выполняет проверку модели и предупреждает, если настроенная модель неизвестна или для нее отсутствует аутентификация.

Пути учетных данных и профилей:

• Профили аутентификации (API-ключи + OAuth): ~/.openclaw/agents/<agentId>/agent/auth-profiles.json
• Импорт устаревшего OAuth: ~/.openclaw/credentials/oauth.json

Режим хранения учетных данных:

• Поведение onboarding по умолчанию сохраняет ключи API как plaintext-значения в auth profiles.
• --secret-input-mode ref включает режим ссылок вместо хранения plaintext-ключей. В интерактивной настройке можно выбрать один из вариантов:
  • ссылка на переменную окружения (например, keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • ссылка на настроенный provider (file или exec) с alias provider + id
• Интерактивный режим ссылок выполняет быструю предварительную проверку перед сохранением.
  • Ссылки env: проверяет имя переменной + непустое значение в текущем окружении onboarding.
  • Ссылки provider: проверяет конфигурацию provider и разрешает запрошенный id.
  • Если предварительная проверка не проходит, onboarding показывает ошибку и позволяет повторить попытку.
• В неинтерактивном режиме --secret-input-mode ref поддерживается только через env.
  • Задайте env var provider в окружении процесса onboarding.
  • Inline-флаги ключей (например, --openai-api-key) требуют, чтобы эта env var была задана; иначе onboarding быстро завершается с ошибкой.
  • Для пользовательских providers неинтерактивный режим ref сохраняет models.providers.<id>.apiKey как { source: "env", provider: "default", id: "CUSTOM_API_KEY" }.
  • В таком случае пользовательского provider --custom-api-key требует, чтобы CUSTOM_API_KEY была задана; иначе onboarding быстро завершается с ошибкой.
• Учетные данные auth для Gateway поддерживают выбор plaintext и SecretRef в интерактивной настройке:
  • Режим токена: Сгенерировать/сохранить plaintext-токен (по умолчанию) или Использовать SecretRef.
  • Режим пароля: plaintext или SecretRef.
• Неинтерактивный путь SecretRef для токена: --gateway-token-ref-env <ENV_VAR>.
• Существующие настройки plaintext продолжают работать без изменений.

Выводы и внутреннее устройство

Типичные поля в ~/.openclaw/openclaw.json:

• agents.defaults.workspace
• agents.defaults.skipBootstrap, когда передан --skip-bootstrap
• agents.defaults.model / models.providers (если выбран Minimax)
• tools.profile (локальный onboarding по умолчанию использует "coding", если значение не задано; существующие явно заданные значения сохраняются)
• gateway.* (режим, привязка, auth, tailscale)
• session.dmScope (локальный onboarding по умолчанию задает per-channel-peer, если значение не задано; существующие явно заданные значения сохраняются)
• channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
• Списки разрешенных каналов (Slack, Discord, Matrix, Microsoft Teams), когда вы соглашаетесь во время подсказок (имена по возможности разрешаются в ID)
• skills.install.nodeManager
  • Флаг setup --node-manager принимает npm, pnpm или bun.
  • Ручная конфигурация все еще может позже задать skills.install.nodeManager: "yarn".
• wizard.lastRunAt
• wizard.lastRunVersion
• wizard.lastRunCommit
• wizard.lastRunCommand
• wizard.lastRunMode

openclaw agents add записывает agents.list[] и необязательные bindings.

Учетные данные WhatsApp помещаются в ~/.openclaw/credentials/whatsapp/<accountId>/. Сессии хранятся в ~/.openclaw/agents/<agentId>/sessions/.

RPC мастера Gateway:

• wizard.start
• wizard.next
• wizard.cancel
• wizard.status

Клиенты (приложение macOS и Control UI) могут отображать шаги без повторной реализации логики onboarding.

Поведение настройки Signal:

• Загружает соответствующий asset релиза
• Сохраняет его в ~/.openclaw/tools/signal-cli/<version>/
• Записывает channels.signal.cliPath в конфигурацию
• JVM-сборки требуют Java 21
• Native-сборки используются, когда доступны
• Windows использует WSL2 и следует Linux-процессу signal-cli внутри WSL

Связанные документы

• Центр onboarding: Onboarding (CLI)
• Автоматизация и скрипты: Автоматизация CLI
• Справочник команд: openclaw onboard