Technical reference
온보딩 참조
이 문서는 openclaw onboard에 대한 전체 참조입니다.
상위 수준 개요는 온보딩(CLI)을 참조하세요.
흐름 세부 정보(로컬 모드)
기존 구성 감지
~/.openclaw/openclaw.json이 있으면 유지 / 수정 / 초기화 중에서 선택합니다.- 온보딩을 다시 실행해도 명시적으로 초기화를 선택하지 않는 한 아무것도 지우지 않습니다
(
--reset을 전달한 경우도 해당). - CLI
--reset의 기본값은config+creds+sessions입니다. 워크스페이스도 제거하려면--reset-scope full을 사용하세요. - 구성이 유효하지 않거나 레거시 키가 포함되어 있으면, 마법사가 중지되고 계속하기 전에
openclaw doctor를 실행하라고 요청합니다. - 초기화는
trash를 사용하며(rm은 절대 사용하지 않음) 다음 범위를 제공합니다.- 구성만
- 구성 + 자격 증명 + 세션
- 전체 초기화(워크스페이스도 제거)
모델/인증
- Anthropic API 키: 있으면
ANTHROPIC_API_KEY를 사용하고, 없으면 키 입력을 요청한 뒤 데몬 사용을 위해 저장합니다. - Anthropic API 키: 온보딩/구성에서 선호되는 Anthropic 어시스턴트 선택입니다.
- Anthropic setup-token: OpenClaw가 이제 가능한 경우 Claude CLI 재사용을 선호하지만, 온보딩/구성에서 여전히 사용할 수 있습니다.
- OpenAI Code (Codex) 구독(OAuth): 브라우저 흐름입니다.
code#state를 붙여넣습니다.- 모델이 설정되지 않았거나 이미 OpenAI 계열이면
agents.defaults.model을openai-codex/gpt-5.5로 설정합니다.
- 모델이 설정되지 않았거나 이미 OpenAI 계열이면
- OpenAI Code (Codex) 구독(디바이스 페어링): 짧은 수명의 디바이스 코드를 사용하는 브라우저 페어링 흐름입니다.
- 모델이 설정되지 않았거나 이미 OpenAI 계열이면
agents.defaults.model을openai-codex/gpt-5.5로 설정합니다.
- 모델이 설정되지 않았거나 이미 OpenAI 계열이면
- OpenAI API 키: 있으면
OPENAI_API_KEY를 사용하고, 없으면 키 입력을 요청한 뒤 인증 프로필에 저장합니다.- 모델이 설정되지 않았거나
openai/*또는openai-codex/*이면agents.defaults.model을openai/gpt-5.5로 설정합니다.
- 모델이 설정되지 않았거나
- xAI (Grok) API 키:
XAI_API_KEY를 요청하고 xAI를 모델 제공자로 구성합니다. - OpenCode:
OPENCODE_API_KEY(또는OPENCODE_ZEN_API_KEY, https://opencode.ai/auth 에서 발급)를 요청하고 Zen 또는 Go 카탈로그를 선택할 수 있게 합니다. - Ollama: 먼저 Cloud + Local, Cloud only, Local only 중에서 제공합니다.
Cloud only는OLLAMA_API_KEY를 요청하고https://ollama.com을 사용합니다. 호스트 기반 모드는 Ollama 기본 URL을 요청하고, 사용 가능한 모델을 검색하며, 필요한 경우 선택한 로컬 모델을 자동으로 가져옵니다.Cloud + Local은 해당 Ollama 호스트가 클라우드 액세스를 위해 로그인되어 있는지도 확인합니다. - 자세한 내용: Ollama
- API 키: 키를 저장해 줍니다.
- Vercel AI Gateway(멀티 모델 프록시):
AI_GATEWAY_API_KEY를 요청합니다. - 자세한 내용: Vercel AI Gateway
- Cloudflare AI Gateway: 계정 ID, Gateway ID,
CLOUDFLARE_AI_GATEWAY_API_KEY를 요청합니다. - 자세한 내용: Cloudflare AI Gateway
- MiniMax: 구성이 자동으로 작성됩니다. 호스팅 기본값은
MiniMax-M2.7입니다. API 키 설정은minimax/...를 사용하고, OAuth 설정은minimax-portal/...을 사용합니다. - 자세한 내용: MiniMax
- StepFun: 중국 또는 글로벌 엔드포인트의 StepFun 표준 또는 Step Plan에 맞게 구성이 자동으로 작성됩니다.
- 현재 표준에는
step-3.5-flash가 포함되며, Step Plan에는step-3.5-flash-2603도 포함됩니다. - 자세한 내용: StepFun
- Synthetic(Anthropic 호환):
SYNTHETIC_API_KEY를 요청합니다. - 자세한 내용: Synthetic
- Moonshot (Kimi K2): 구성이 자동으로 작성됩니다.
- Kimi Coding: 구성이 자동으로 작성됩니다.
- 자세한 내용: Moonshot AI (Kimi + Kimi Coding)
- 건너뛰기: 아직 인증을 구성하지 않습니다.
- 감지된 옵션에서 기본 모델을 선택하거나 제공자/모델을 직접 입력합니다. 최고의 품질과 더 낮은 프롬프트 인젝션 위험을 위해, 제공자 스택에서 사용할 수 있는 가장 강력한 최신 세대 모델을 선택하세요.
- 온보딩은 모델 검사를 실행하고 구성된 모델을 알 수 없거나 인증이 누락된 경우 경고합니다.
- API 키 저장 모드는 기본적으로 일반 텍스트 인증 프로필 값입니다. 대신 환경 변수 기반 참조를 저장하려면
--secret-input-mode ref를 사용하세요(예:keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }). - 인증 프로필은
~/.openclaw/agents/<agentId>/agent/auth-profiles.json에 있습니다(API 키 + OAuth).~/.openclaw/credentials/oauth.json은 레거시 가져오기 전용입니다. - 자세한 내용: /concepts/oauth
워크스페이스
- 기본값은
~/.openclaw/workspace입니다(구성 가능). - 에이전트 부트스트랩 절차에 필요한 워크스페이스 파일을 시드합니다.
- 전체 워크스페이스 레이아웃 + 백업 가이드: 에이전트 워크스페이스
Gateway
- 포트, 바인드, 인증 모드, Tailscale 노출입니다.
- 인증 권장 사항: 로컬 WS 클라이언트도 인증해야 하도록 loopback에서도 Token을 유지하세요.
- 토큰 모드에서 대화형 설정은 다음을 제공합니다.
- 일반 텍스트 토큰 생성/저장(기본값)
- SecretRef 사용(선택 사항)
- Quickstart는 온보딩 프로브/대시보드 부트스트랩을 위해
env,file,exec제공자 전반에서 기존gateway.auth.tokenSecretRef를 재사용합니다. - 해당 SecretRef가 구성되어 있지만 해석할 수 없으면, 온보딩은 런타임 인증을 조용히 약화하지 않고 명확한 수정 메시지와 함께 일찍 실패합니다.
- 비밀번호 모드에서 대화형 설정은 일반 텍스트 또는 SecretRef 저장도 지원합니다.
- 비대화형 토큰 SecretRef 경로:
--gateway-token-ref-env <ENV_VAR>.- 온보딩 프로세스 환경에 비어 있지 않은 환경 변수가 필요합니다.
--gateway-token과 함께 사용할 수 없습니다.
- 모든 로컬 프로세스를 완전히 신뢰하는 경우에만 인증을 비활성화하세요.
- loopback이 아닌 바인드는 여전히 인증이 필요합니다.
채널
- WhatsApp: 선택적 QR 로그인.
- Telegram: 봇 토큰.
- Discord: 봇 토큰.
- Google Chat: 서비스 계정 JSON + Webhook 대상.
- Mattermost (Plugin): 봇 토큰 + 기본 URL.
- Signal: 선택적
signal-cli설치 + 계정 구성. - BlueBubbles: iMessage에 권장; 서버 URL + 비밀번호 + Webhook.
- iMessage: 레거시
imsgCLI 경로 + DB 액세스. - DM 보안: 기본값은 페어링입니다. 첫 DM이 코드를 보냅니다.
openclaw pairing approve <channel> <code>로 승인하거나 허용 목록을 사용하세요.
웹 검색
- Brave, DuckDuckGo, Exa, Firecrawl, Gemini, Grok, Kimi, MiniMax Search, Ollama Web Search, Perplexity, SearXNG, Tavily 같은 지원 제공자를 선택하거나 건너뜁니다.
- API 기반 제공자는 빠른 설정에 환경 변수나 기존 구성을 사용할 수 있습니다. 키가 필요 없는 제공자는 대신 제공자별 필수 조건을 사용합니다.
--skip-search로 건너뜁니다.- 나중에 구성:
openclaw configure --section web.
데몬 설치
- macOS: LaunchAgent
- 로그인한 사용자 세션이 필요합니다. 헤드리스의 경우 사용자 지정 LaunchDaemon을 사용하세요(제공되지 않음).
- Linux(및 WSL2를 통한 Windows): systemd 사용자 유닛
- 온보딩은 로그아웃 후에도 Gateway가 계속 실행되도록
loginctl enable-linger <user>로 lingering 활성화를 시도합니다. - sudo를 요청할 수 있습니다(
/var/lib/systemd/linger에 기록). 먼저 sudo 없이 시도합니다.
- 온보딩은 로그아웃 후에도 Gateway가 계속 실행되도록
- 런타임 선택: Node(권장, WhatsApp/Telegram에 필요). Bun은 권장하지 않습니다.
- 토큰 인증에 토큰이 필요하고
gateway.auth.token이 SecretRef로 관리되는 경우, 데몬 설치는 이를 검증하지만 해석된 일반 텍스트 토큰 값을 supervisor 서비스 환경 메타데이터에 유지하지 않습니다. - 토큰 인증에 토큰이 필요하고 구성된 토큰 SecretRef가 해석되지 않으면, 실행 가능한 안내와 함께 데몬 설치가 차단됩니다.
gateway.auth.token과gateway.auth.password가 모두 구성되어 있고gateway.auth.mode가 설정되지 않은 경우, 모드가 명시적으로 설정될 때까지 데몬 설치가 차단됩니다.
상태 검사
- Gateway를 시작하고(필요한 경우)
openclaw health를 실행합니다. - 팁:
openclaw status --deep은 실시간 Gateway 상태 프로브를 상태 출력에 추가하며, 지원되는 경우 채널 프로브도 포함합니다(연결 가능한 Gateway 필요).
Skills(권장)
- 사용 가능한 Skills를 읽고 요구 사항을 확인합니다.
- Node 관리자를 선택할 수 있게 합니다: npm / pnpm(bun은 권장하지 않음).
- 선택적 종속성을 설치합니다(일부는 macOS에서 Homebrew 사용).
마침
- 추가 기능을 위한 iOS/Android/macOS 앱을 포함한 요약 + 다음 단계입니다.
비대화형 모드
온보딩을 자동화하거나 스크립트화하려면 --non-interactive를 사용하세요.
openclaw onboard --non-interactive \
--mode local \
--auth-choice apiKey \
--anthropic-api-key "$ANTHROPIC_API_KEY" \
--gateway-port 18789 \
--gateway-bind loopback \
--install-daemon \
--daemon-runtime node \
--skip-skills
머신이 읽을 수 있는 요약을 보려면 --json을 추가하세요.
비대화형 모드의 Gateway 토큰 SecretRef:
export OPENCLAW_GATEWAY_TOKEN="your-token"
openclaw onboard --non-interactive \
--mode local \
--auth-choice skip \
--gateway-auth token \
--gateway-token-ref-env OPENCLAW_GATEWAY_TOKEN
--gateway-token과 --gateway-token-ref-env는 서로 배타적입니다.
제공자별 명령 예시는 CLI 자동화에 있습니다. 플래그 의미와 단계 순서는 이 참조 페이지를 사용하세요.
에이전트 추가(비대화형)
openclaw agents add work \
--workspace ~/.openclaw/workspace-work \
--model openai/gpt-5.5 \
--bind whatsapp:biz \
--non-interactive \
--json
Gateway 마법사 RPC
Gateway는 RPC(wizard.start, wizard.next, wizard.cancel, wizard.status)를 통해 온보딩 흐름을 노출합니다.
클라이언트(macOS 앱, Control UI)는 온보딩 로직을 다시 구현하지 않고 단계를 렌더링할 수 있습니다.
Signal 설정(signal-cli)
온보딩은 GitHub 릴리스에서 signal-cli를 설치할 수 있습니다.
- 적절한 릴리스 자산을 다운로드합니다.
~/.openclaw/tools/signal-cli/<version>/아래에 저장합니다.- 구성에
channels.signal.cliPath를 작성합니다.
참고:
- JVM 빌드는 Java 21이 필요합니다.
- 사용 가능한 경우 네이티브 빌드를 사용합니다.
- Windows는 WSL2를 사용합니다. signal-cli 설치는 WSL 내부의 Linux 흐름을 따릅니다.
마법사가 작성하는 내용
~/.openclaw/openclaw.json의 일반적인 필드:
agents.defaults.workspaceagents.defaults.model/models.providers(Minimax를 선택한 경우)tools.profile(설정되지 않은 경우 로컬 온보딩의 기본값은"coding"입니다. 기존의 명시적 값은 보존됩니다)gateway.*(mode, bind, auth, tailscale)session.dmScope(동작 세부 정보: CLI 설정 참조)channels.telegram.botToken,channels.discord.token,channels.matrix.*,channels.signal.*,channels.imessage.*- 프롬프트 중에 선택하는 경우 채널 허용 목록(Slack/Discord/Matrix/Microsoft Teams)(가능한 경우 이름이 ID로 확인됨).
skills.install.nodeManagersetup --node-manager는npm,pnpm또는bun을 허용합니다.- 수동 구성에서는
skills.install.nodeManager를 직접 설정하여 계속yarn을 사용할 수 있습니다.
wizard.lastRunAtwizard.lastRunVersionwizard.lastRunCommitwizard.lastRunCommandwizard.lastRunMode
openclaw agents add는 agents.list[]와 선택적 bindings를 기록합니다.
WhatsApp 자격 증명은 ~/.openclaw/credentials/whatsapp/<accountId>/ 아래에 저장됩니다.
세션은 ~/.openclaw/agents/<agentId>/sessions/ 아래에 저장됩니다.
일부 채널은 Plugin으로 제공됩니다. 설정 중 하나를 선택하면 구성하기 전에 온보딩에서 해당 Plugin을 설치하도록 안내합니다(npm 또는 로컬 경로).
관련 문서
- 온보딩 개요: 온보딩(CLI)
- macOS 앱 온보딩: 온보딩
- 구성 참조: Gateway 구성
- 제공자: WhatsApp, Telegram, Discord, Google Chat, Signal, BlueBubbles(iMessage), iMessage(레거시)
- Skills: Skills, Skills 구성