이 페이지는Documentation Index
Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
openclaw onboard의 전체 참조입니다.
짧은 가이드는 온보딩(CLI)을 참조하세요.
마법사가 수행하는 작업
로컬 모드(기본값)는 다음을 안내합니다.- 모델 및 인증 설정(OpenAI Code 구독 OAuth, Anthropic Claude CLI 또는 API 키, 그리고 MiniMax, GLM, Ollama, Moonshot, StepFun, AI Gateway 옵션)
- 워크스페이스 위치 및 부트스트랩 파일
- Gateway 설정(포트, 바인드, 인증, Tailscale)
- 채널 및 제공자(Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, iMessage 및 기타 번들 채널 Plugin)
- 데몬 설치(LaunchAgent, systemd 사용자 유닛 또는 시작 폴더 폴백이 있는 네이티브 Windows 예약 작업)
- 상태 확인
- Skills 설정
로컬 흐름 세부 정보
기존 구성 감지
~/.openclaw/openclaw.json이 있으면 유지, 수정 또는 재설정을 선택합니다.- 마법사를 다시 실행해도 재설정을 명시적으로 선택하거나
--reset을 전달하지 않는 한 아무것도 지우지 않습니다. - CLI
--reset의 기본값은config+creds+sessions입니다. 워크스페이스도 제거하려면--reset-scope full을 사용하세요. - 구성이 유효하지 않거나 레거시 키를 포함하면, 마법사는 중지하고 계속하기 전에
openclaw doctor를 실행하라고 요청합니다. - 재설정은
trash를 사용하며 다음 범위를 제공합니다.- 구성만
- 구성 + 자격 증명 + 세션
- 전체 재설정(워크스페이스도 제거)
모델 및 인증
- 전체 옵션 매트릭스는 인증 및 모델 옵션에 있습니다.
워크스페이스
- 기본값은
~/.openclaw/workspace입니다(구성 가능). - 첫 실행 부트스트랩 절차에 필요한 워크스페이스 파일을 시드합니다.
- 워크스페이스 레이아웃: 에이전트 워크스페이스.
Gateway
- 포트, 바인드, 인증 모드 및 Tailscale 노출을 묻습니다.
- 권장: 루프백에서도 토큰 인증을 활성화해 로컬 WS 클라이언트가 인증하도록 하세요.
- 토큰 모드에서 대화형 설정은 다음을 제공합니다.
- 평문 토큰 생성/저장(기본값)
- SecretRef 사용(선택 사항)
- 비밀번호 모드에서 대화형 설정은 평문 또는 SecretRef 저장도 지원합니다.
- 비대화형 토큰 SecretRef 경로:
--gateway-token-ref-env <ENV_VAR>.- 온보딩 프로세스 환경에 비어 있지 않은 환경 변수가 필요합니다.
--gateway-token과 함께 사용할 수 없습니다.
- 모든 로컬 프로세스를 완전히 신뢰하는 경우에만 인증을 비활성화하세요.
- 비루프백 바인드에는 여전히 인증이 필요합니다.
채널
- WhatsApp: 선택적 QR 로그인
- Telegram: 봇 토큰
- Discord: 봇 토큰
- Google Chat: 서비스 계정 JSON + Webhook 대상
- Mattermost: 봇 토큰 + 기본 URL
- Signal: 선택적
signal-cli설치 + 계정 구성 - iMessage:
imsgCLI 경로 + Messages DB 접근. Gateway가 Mac 외부에서 실행될 때는 SSH 래퍼를 사용하세요. - DM 보안: 기본값은 페어링입니다. 첫 DM은 코드를 전송합니다. 다음으로 승인하세요.
openclaw pairing approve <channel> <code>또는 허용 목록을 사용하세요.
데몬 설치
- macOS: LaunchAgent
- 로그인된 사용자 세션이 필요합니다. 헤드리스의 경우 사용자 지정 LaunchDaemon을 사용하세요(제공되지 않음).
- Linux 및 WSL2를 통한 Windows: systemd 사용자 유닛
- 마법사는 로그아웃 후에도 Gateway가 계속 실행되도록
loginctl enable-linger <user>를 시도합니다. - sudo를 요청할 수 있습니다(
/var/lib/systemd/linger에 씀). 먼저 sudo 없이 시도합니다.
- 마법사는 로그아웃 후에도 Gateway가 계속 실행되도록
- 네이티브 Windows: 예약 작업 우선
- 작업 생성이 거부되면 OpenClaw는 사용자별 시작 폴더 로그인 항목으로 폴백하고 Gateway를 즉시 시작합니다.
- 예약 작업은 더 나은 감독자 상태를 제공하므로 계속 권장됩니다.
- 런타임 선택: Node(권장, WhatsApp 및 Telegram에 필요). Bun은 권장되지 않습니다.
상태 확인
- 필요한 경우 Gateway를 시작하고
openclaw health를 실행합니다. openclaw status --deep은 지원되는 경우 채널 프로브를 포함해 실시간 Gateway 상태 프로브를 상태 출력에 추가합니다.
Skills
- 사용 가능한 Skills를 읽고 요구 사항을 확인합니다.
- Node 관리자를 선택하게 합니다: npm, pnpm 또는 bun.
- 선택적 의존성을 설치합니다(일부는 macOS에서 Homebrew를 사용).
GUI가 감지되지 않으면 마법사는 브라우저를 여는 대신 Control UI용 SSH 포트 포워딩 지침을 출력합니다.
Control UI 자산이 없으면 마법사가 빌드를 시도합니다. 폴백은
pnpm ui:build입니다(UI 의존성 자동 설치).원격 모드 세부 정보
원격 모드는 이 머신이 다른 곳의 Gateway에 연결하도록 구성합니다.원격 모드는 원격 호스트에 아무것도 설치하거나 수정하지 않습니다.
- 원격 Gateway URL(
ws://...) - 원격 Gateway 인증이 필요한 경우 토큰(권장)
- Gateway가 루프백 전용이면 SSH 터널링 또는 tailnet을 사용하세요.
- 탐색 힌트:
- macOS: Bonjour(
dns-sd) - Linux: Avahi(
avahi-browse)
- macOS: Bonjour(
인증 및 모델 옵션
Anthropic API 키
Anthropic API 키
ANTHROPIC_API_KEY가 있으면 사용하거나 키를 요청한 다음, 데몬 사용을 위해 저장합니다.OpenAI Code 구독(OAuth)
OpenAI Code 구독(OAuth)
브라우저 흐름입니다.
code#state를 붙여넣으세요.모델이 설정되지 않았거나 이미 OpenAI 계열인 경우 Codex 런타임을 통해 agents.defaults.model을 openai/gpt-5.5로 설정합니다.OpenAI Code 구독(기기 페어링)
OpenAI Code 구독(기기 페어링)
수명이 짧은 기기 코드를 사용하는 브라우저 페어링 흐름입니다.모델이 설정되지 않았거나 이미 OpenAI 계열인 경우 Codex 런타임을 통해
agents.defaults.model을 openai/gpt-5.5로 설정합니다.OpenAI API 키
OpenAI API 키
OPENAI_API_KEY가 있으면 사용하거나 키를 요청한 다음, 인증 프로필에 자격 증명을 저장합니다.모델이 설정되지 않았거나 openai/* 또는 openai-codex/*인 경우 agents.defaults.model을 openai/gpt-5.5로 설정합니다.xAI(Grok) API 키
xAI(Grok) API 키
XAI_API_KEY를 요청하고 xAI를 모델 제공자로 구성합니다.OpenCode
OpenCode
OPENCODE_API_KEY(또는 OPENCODE_ZEN_API_KEY)를 요청하고 Zen 또는 Go 카탈로그를 선택하게 합니다.
설정 URL: opencode.ai/auth.API 키(일반)
API 키(일반)
키를 대신 저장합니다.
Vercel AI Gateway
Vercel AI Gateway
AI_GATEWAY_API_KEY를 요청합니다.
자세한 내용: Vercel AI Gateway.Cloudflare AI Gateway
Cloudflare AI Gateway
계정 ID, Gateway ID 및
CLOUDFLARE_AI_GATEWAY_API_KEY를 요청합니다.
자세한 내용: Cloudflare AI Gateway.MiniMax
MiniMax
구성이 자동으로 작성됩니다. 호스팅 기본값은
MiniMax-M2.7입니다. API 키 설정은
minimax/...를 사용하고, OAuth 설정은 minimax-portal/...을 사용합니다.
자세한 내용: MiniMax.StepFun
StepFun
StepFun 표준 또는 중국/글로벌 엔드포인트의 Step Plan에 맞게 구성이 자동으로 작성됩니다.
현재 표준에는
step-3.5-flash가 포함되며, Step Plan에는 step-3.5-flash-2603도 포함됩니다.
자세한 내용: StepFun.Synthetic(Anthropic 호환)
Synthetic(Anthropic 호환)
SYNTHETIC_API_KEY를 요청합니다.
자세한 내용: Synthetic.Ollama(Cloud 및 로컬 오픈 모델)
Ollama(Cloud 및 로컬 오픈 모델)
먼저
Cloud + Local, Cloud only 또는 Local only를 요청합니다.
Cloud only는 https://ollama.com과 함께 OLLAMA_API_KEY를 사용합니다.
호스트 기반 모드는 기본 URL(기본값 http://127.0.0.1:11434)을 요청하고, 사용 가능한 모델을 탐색하며 기본값을 제안합니다.
Cloud + Local은 해당 Ollama 호스트가 클라우드 접근을 위해 로그인되어 있는지도 확인합니다.
자세한 내용: Ollama.Moonshot 및 Kimi Coding
Moonshot 및 Kimi Coding
Moonshot(Kimi K2) 및 Kimi Coding 구성이 자동으로 작성됩니다.
자세한 내용: Moonshot AI(Kimi + Kimi Coding).
사용자 지정 제공자
사용자 지정 제공자
OpenAI 호환 및 Anthropic 호환 엔드포인트와 함께 작동합니다.대화형 온보딩은 다른 제공자 API 키 흐름과 동일한 API 키 저장 선택지를 지원합니다.
- 지금 API 키 붙여넣기(평문)
- 비밀 참조 사용(env 참조 또는 구성된 제공자 참조, 사전 검증 포함)
--auth-choice custom-api-key--custom-base-url--custom-model-id--custom-api-key(선택 사항.CUSTOM_API_KEY로 폴백)--custom-provider-id(선택 사항)--custom-compatibility <openai|anthropic>(선택 사항. 기본값openai)--custom-image-input/--custom-text-input(선택 사항. 추론된 모델 입력 기능을 재정의)
건너뛰기
건너뛰기
인증을 구성하지 않은 상태로 둡니다.
- 감지된 옵션에서 기본 모델을 선택하거나 제공자와 모델을 수동으로 입력합니다.
- 사용자 지정 제공자 온보딩은 일반적인 모델 ID에 대해 이미지 지원을 추론하며, 모델 이름을 알 수 없는 경우에만 묻습니다.
- 온보딩이 제공자 인증 선택에서 시작되면 모델 선택기는
해당 제공자를 자동으로 우선합니다. Volcengine 및 BytePlus의 경우 동일한 선호가
코딩 플랜 변형(
volcengine-plan/*,byteplus-plan/*)에도 일치합니다. - 해당 선호 제공자 필터가 비어 있으면 선택기는 모델을 표시하지 않는 대신 전체 카탈로그로 폴백합니다.
- 마법사는 모델 검사를 실행하고 구성된 모델을 알 수 없거나 인증이 누락된 경우 경고합니다.
- 인증 프로필(API 키 + OAuth):
~/.openclaw/agents/<agentId>/agent/auth-profiles.json - 레거시 OAuth 가져오기:
~/.openclaw/credentials/oauth.json
- 기본 온보딩 동작은 API 키를 인증 프로필에 평문 값으로 유지합니다.
--secret-input-mode ref는 평문 키 저장 대신 참조 모드를 활성화합니다. 대화형 설정에서는 다음 중 하나를 선택할 수 있습니다.- 환경 변수 참조(예:
keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }) - 제공자 별칭 + ID가 있는 구성된 제공자 참조(
file또는exec)
- 환경 변수 참조(예:
- 대화형 참조 모드는 저장 전에 빠른 사전 검증을 실행합니다.
- env 참조: 현재 온보딩 환경에서 변수 이름 + 비어 있지 않은 값을 검증합니다.
- 제공자 참조: 제공자 구성을 검증하고 요청된 ID를 확인합니다.
- 사전 검증이 실패하면 온보딩은 오류를 표시하고 다시 시도할 수 있게 합니다.
- 비대화형 모드에서
--secret-input-mode ref는 env 기반만 지원합니다.- 온보딩 프로세스 환경에 제공자 환경 변수를 설정하세요.
- 인라인 키 플래그(예:
--openai-api-key)는 해당 환경 변수가 설정되어 있어야 합니다. 그렇지 않으면 온보딩이 빠르게 실패합니다. - 사용자 지정 제공자의 경우 비대화형
ref모드는models.providers.<id>.apiKey를{ source: "env", provider: "default", id: "CUSTOM_API_KEY" }로 저장합니다. - 해당 사용자 지정 제공자 사례에서
--custom-api-key는CUSTOM_API_KEY가 설정되어 있어야 합니다. 그렇지 않으면 온보딩이 빠르게 실패합니다.
- Gateway 인증 자격 증명은 대화형 설정에서 평문 및 SecretRef 선택을 지원합니다.
- 토큰 모드: 평문 토큰 생성/저장(기본값) 또는 SecretRef 사용.
- 비밀번호 모드: 평문 또는 SecretRef.
- 비대화형 토큰 SecretRef 경로:
--gateway-token-ref-env <ENV_VAR>. - 기존 평문 설정은 변경 없이 계속 작동합니다.
Headless 및 서버 팁: 브라우저가 있는 머신에서 OAuth를 완료한 다음,
해당 에이전트의
auth-profiles.json(예:
~/.openclaw/agents/<agentId>/agent/auth-profiles.json 또는 일치하는
$OPENCLAW_STATE_DIR/... 경로)을 gateway 호스트로 복사하세요. credentials/oauth.json은
레거시 가져오기 소스로만 사용됩니다.출력 및 내부 구조
~/.openclaw/openclaw.json의 일반적인 필드:
agents.defaults.workspace--skip-bootstrap이 전달된 경우agents.defaults.skipBootstrapagents.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.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/ 아래에 저장됩니다.
일부 채널은 plugins로 제공됩니다. 설정 중 선택하면 마법사가
채널 구성 전에 plugin(npm 또는 로컬 경로)을 설치하라는 프롬프트를 표시합니다.
wizard.startwizard.nextwizard.cancelwizard.status
- 적절한 릴리스 에셋 다운로드
~/.openclaw/tools/signal-cli/<version>/아래에 저장- 구성에
channels.signal.cliPath작성 - JVM 빌드에는 Java 21이 필요함
- 사용 가능한 경우 네이티브 빌드 사용
- Windows는 WSL2를 사용하며 WSL 내부에서 Linux signal-cli 흐름을 따름
관련 문서
- 온보딩 허브: 온보딩 (CLI)
- 자동화 및 스크립트: CLI 자동화
- 명령어 참조:
openclaw onboard