Довідник із налаштування CLI

Ця сторінка є повним довідником для openclaw onboard. Короткий посібник див. у Онбординг (CLI).

# Що робить майстер

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

• Налаштування моделі й автентифікації (OAuth для підписки OpenAI Code, Anthropic Claude CLI або ключ API, а також варіанти MiniMax, GLM, Ollama, Moonshot, StepFun і AI Gateway)
• Розташування робочого простору та bootstrap-файли
• Налаштування Gateway (порт, прив’язка, автентифікація, Tailscale)
• Канали й провайдери (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, BlueBubbles та інші вбудовані channel plugins)
• Встановлення демона (LaunchAgent, користувацький systemd unit або нативне Windows Scheduled Task із fallback до папки Startup)
• Перевірка стану
• Налаштування Skills

Віддалений режим налаштовує цю машину для підключення до Gateway в іншому місці. Він нічого не встановлює і не змінює на віддаленому хості.

# Деталі локального потоку

# Деталі віддаленого режиму

Віддалений режим налаштовує цю машину для підключення до Gateway в іншому місці.

Що ви задаєте:

• URL-адреса віддаленого Gateway (ws://...)
• Токен, якщо віддалений Gateway потребує автентифікації (рекомендовано)

# Варіанти автентифікації та моделей

Поведінка моделі:

• Виберіть типову модель із виявлених варіантів або введіть провайдера й модель вручну.
• Онбординг користувацького провайдера виводить підтримку зображень для поширених ID моделей і запитує лише тоді, коли назва моделі невідома.
• Коли онбординг починається з вибору автентифікації провайдера, picker моделей автоматично надає перевагу цьому провайдеру. Для Volcengine і BytePlus та сама перевага також збігається з їхніми варіантами coding-plan (volcengine-plan/*, byteplus-plan/*).
• Якщо цей preferred-provider filter був би порожнім, picker повертається до повного каталогу замість показу відсутності моделей.
• Майстер запускає перевірку моделі й попереджає, якщо налаштована модель невідома або бракує автентифікації.

Шляхи облікових даних і профілів:

• Auth profiles (ключі API + OAuth): ~/.openclaw/agents/<agentId>/agent/auth-profiles.json
• Імпорт legacy OAuth: ~/.openclaw/credentials/oauth.json

Режим зберігання облікових даних:

• Типова поведінка онбордингу зберігає ключі API як plaintext values в auth profiles.
• --secret-input-mode ref вмикає reference mode замість зберігання plaintext key. В інтерактивному налаштуванні можна вибрати одне з:
  • посилання на змінну середовища (наприклад keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • налаштований provider ref (file або exec) з provider alias + id
• Інтерактивний reference mode виконує швидку preflight validation перед збереженням.
  • Env refs: перевіряє назву змінної + непорожнє значення в поточному середовищі онбордингу.
  • Provider refs: перевіряє конфігурацію провайдера й resolve requested id.
  • Якщо preflight fails, онбординг показує помилку й дає змогу повторити.
• У неінтерактивному режимі --secret-input-mode ref підтримується лише через env.
  • Задайте provider env var у середовищі процесу онбордингу.
  • Inline key flags (наприклад --openai-api-key) потребують, щоб ця env var була задана; інакше онбординг швидко завершується з помилкою.
  • Для користувацьких провайдерів неінтерактивний режим ref зберігає models.providers.<id>.apiKey як { source: "env", provider: "default", id: "CUSTOM_API_KEY" }.
  • У цьому випадку користувацького провайдера --custom-api-key потребує, щоб CUSTOM_API_KEY був заданий; інакше онбординг швидко завершується з помилкою.
• Облікові дані автентифікації Gateway підтримують варіанти plaintext і SecretRef в інтерактивному налаштуванні:
  • Режим токена: Згенерувати/зберегти plaintext token (типово) або Використати 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 (локальне початкове налаштування за замовчуванням використовує "coding", якщо не задано; наявні явні значення зберігаються)
• gateway.* (режим, прив’язка, автентифікація, tailscale)
• session.dmScope (локальне початкове налаштування за замовчуванням задає це як 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) можуть відображати кроки без повторної реалізації логіки початкового налаштування.

Поведінка налаштування Signal:

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

# Пов’язані документи

• Хаб початкового налаштування: Початкове налаштування (CLI)
• Автоматизація та скрипти: Автоматизація CLI
• Довідник команд: openclaw onboard