17 KiB
17 KiB
| read_when | sidebarTitle | summary | title | x-i18n | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
CLI reference | CLI 설정 흐름, 인증/모델 설정, 출력 및 내부 동작에 대한 완전한 참조 | CLI 설정 참조 |
|
CLI 설정 참조
이 페이지는 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, BlueBubbles 및 기타 번들 채널 Plugin)
- 데몬 설치(LaunchAgent, systemd 사용자 유닛 또는 기본 Windows Scheduled Task와 Startup 폴더 대체 경로)
- 상태 점검
- Skills 설정
원격 모드는 이 컴퓨터가 다른 위치의 gateway에 연결되도록 구성합니다. 원격 호스트에는 아무것도 설치하거나 수정하지 않습니다.
로컬 흐름 세부사항
- `~/.openclaw/openclaw.json`이 있으면 Keep, Modify 또는 Reset을 선택합니다. - 마법사를 다시 실행해도 명시적으로 Reset을 선택하지 않는 한(또는 `--reset`을 전달하지 않는 한) 아무것도 지워지지 않습니다. - CLI `--reset`의 기본값은 `config+creds+sessions`이며, 워크스페이스까지 제거하려면 `--reset-scope full`을 사용하세요. - 구성이 유효하지 않거나 레거시 키를 포함하면, 마법사는 중단하고 계속하기 전에 `openclaw doctor`를 실행하라고 요청합니다. - Reset은 `trash`를 사용하며 다음 범위를 제공합니다. - 구성만 - 구성 + 자격 증명 + 세션 - 전체 재설정(워크스페이스도 제거) - 전체 옵션 매트릭스는 [인증 및 모델 옵션](#auth-and-model-options)에 있습니다. - 기본값은 `~/.openclaw/workspace`입니다(구성 가능). - 첫 실행 부트스트랩 의식에 필요한 워크스페이스 파일을 시드합니다. - 워크스페이스 레이아웃: [에이전트 워크스페이스](/ko/concepts/agent-workspace). - 포트, 바인드, 인증 모드, Tailscale 노출 여부를 묻습니다. - 권장 사항: 로컬 WS 클라이언트도 인증해야 하므로 loopback만 사용하더라도 토큰 인증을 활성화한 상태로 유지하세요. - 토큰 모드에서 대화형 설정은 다음을 제공합니다. - **일반 텍스트 토큰 생성/저장** (기본값) - **SecretRef 사용** (옵트인) - 비밀번호 모드에서도 대화형 설정은 일반 텍스트 또는 SecretRef 저장을 지원합니다. - 비대화형 토큰 SecretRef 경로: `--gateway-token-ref-env `. - 온보딩 프로세스 환경에 비어 있지 않은 환경 변수가 필요합니다. - `--gateway-token`과 함께 사용할 수 없습니다. - 모든 로컬 프로세스를 완전히 신뢰하는 경우에만 인증을 비활성화하세요. - loopback이 아닌 바인드도 여전히 인증이 필요합니다. - [WhatsApp](/ko/channels/whatsapp): 선택적 QR 로그인 - [Telegram](/ko/channels/telegram): 봇 토큰 - [Discord](/ko/channels/discord): 봇 토큰 - [Google Chat](/ko/channels/googlechat): 서비스 계정 JSON + Webhook audience - [Mattermost](/ko/channels/mattermost): 봇 토큰 + 기본 URL - [Signal](/ko/channels/signal): 선택적 `signal-cli` 설치 + 계정 구성 - [BlueBubbles](/ko/channels/bluebubbles): iMessage에 권장; 서버 URL + 비밀번호 + Webhook - [iMessage](/ko/channels/imessage): 레거시 `imsg` CLI 경로 + DB 접근 - DM 보안: 기본값은 페어링입니다. 첫 DM은 코드를 전송하며, `openclaw pairing approve`로 승인하거나 allowlist를 사용할 수 있습니다.
- macOS: LaunchAgent
- 로그인된 사용자 세션이 필요합니다. 헤드리스 환경에서는 사용자 지정 LaunchDaemon을 사용하세요(기본 제공되지 않음).
- Linux 및 WSL2를 통한 Windows: systemd 사용자 유닛
- 마법사는 로그아웃 후에도 gateway가 계속 실행되도록 `loginctl enable-linger `를 시도합니다.
- sudo를 요청할 수 있습니다(`/var/lib/systemd/linger`에 기록). 먼저 sudo 없이 시도합니다.
- 기본 Windows: 먼저 Scheduled Task
- 작업 생성이 거부되면, OpenClaw는 사용자별 Startup 폴더 로그인 항목으로 대체하고 gateway를 즉시 시작합니다.
- Scheduled Task는 더 나은 supervisor 상태를 제공하므로 여전히 선호됩니다.
- 런타임 선택: Node(권장, WhatsApp 및 Telegram에 필요). Bun은 권장되지 않습니다.
- 필요하면 gateway를 시작하고 `openclaw health`를 실행합니다.
- `openclaw status --deep`는 지원되는 경우 채널 프로브를 포함한 라이브 gateway 상태 프로브를 상태 출력에 추가합니다.
- 사용 가능한 Skills를 읽고 요구 사항을 확인합니다.
- 노드 관리자로 npm, pnpm 또는 bun을 선택할 수 있습니다.
- 선택적 의존성을 설치합니다(일부는 macOS에서 Homebrew 사용).
- 요약 및 다음 단계(iOS, Android, macOS 앱 옵션 포함)를 제공합니다.
GUI가 감지되지 않으면, 마법사는 브라우저를 여는 대신 Control UI용 SSH 포트 포워딩 지침을 출력합니다.
Control UI 자산이 없으면, 마법사는 이를 빌드하려고 시도합니다. 대체 경로는 `pnpm ui:build`이며(UI 의존성을 자동 설치함)입니다.
원격 모드 세부사항
원격 모드는 이 컴퓨터가 다른 위치의 gateway에 연결되도록 구성합니다.
원격 모드는 원격 호스트에 아무것도 설치하거나 수정하지 않습니다.
설정하는 항목:
- 원격 gateway URL (
ws://...)
- 원격 gateway 인증이 필요한 경우 토큰(권장)
- gateway가 loopback 전용이면 SSH 터널링 또는 tailnet을 사용하세요.
- 검색 힌트:
- macOS: Bonjour (`dns-sd`)
- Linux: Avahi (`avahi-browse`)
인증 및 모델 옵션
`ANTHROPIC_API_KEY`가 있으면 이를 사용하고, 없으면 키를 요청한 뒤 데몬에서 사용할 수 있도록 저장합니다.
`~/.codex/auth.json`이 있으면 마법사가 이를 재사용할 수 있습니다.
재사용된 Codex CLI 자격 증명은 계속 Codex CLI가 관리합니다. 만료되면 OpenClaw는
먼저 해당 소스를 다시 읽고, 제공자가 이를 갱신할 수 있으면
자격 증명의 소유권을 가져오지 않고 갱신된 자격 증명을 다시 Codex 저장소에 기록합니다.
브라우저 흐름이며 `code#state`를 붙여 넣습니다.
모델이 설정되지 않았거나 `openai/*`인 경우 `agents.defaults.model`을 `openai-codex/gpt-5.4`로 설정합니다.
`OPENAI_API_KEY`가 있으면 이를 사용하고, 없으면 키를 요청한 뒤 자격 증명을 auth profile에 저장합니다.
모델이 설정되지 않았거나 `openai/*` 또는 `openai-codex/*`인 경우 `agents.defaults.model`을 `openai/gpt-5.4`로 설정합니다.
`XAI_API_KEY`를 요청하고 xAI를 모델 제공자로 구성합니다.
`OPENCODE_API_KEY`(또는 `OPENCODE_ZEN_API_KEY`)를 요청하고 Zen 또는 Go 카탈로그를 선택하게 합니다.
설정 URL: [opencode.ai/auth](https://opencode.ai/auth).
키를 대신 저장합니다.
`AI_GATEWAY_API_KEY`를 요청합니다.
자세한 내용: [Vercel AI Gateway](/ko/providers/vercel-ai-gateway).
계정 ID, gateway ID, `CLOUDFLARE_AI_GATEWAY_API_KEY`를 요청합니다.
자세한 내용: [Cloudflare AI Gateway](/ko/providers/cloudflare-ai-gateway).
구성이 자동으로 기록됩니다. 호스팅 기본값은 `MiniMax-M2.7`이며, API 키 설정은
`minimax/...`를 사용하고 OAuth 설정은 `minimax-portal/...`을 사용합니다.
자세한 내용: [MiniMax](/ko/providers/minimax).
중국 또는 글로벌 엔드포인트의 StepFun standard 또는 Step Plan에 맞게 구성이 자동으로 기록됩니다.
Standard에는 현재 `step-3.5-flash`가 포함되며, Step Plan에는 `step-3.5-flash-2603`도 포함됩니다.
자세한 내용: [StepFun](/ko/providers/stepfun).
`SYNTHETIC_API_KEY`를 요청합니다.
자세한 내용: [Synthetic](/ko/providers/synthetic).
먼저 `Cloud + Local`, `Cloud only`, `Local only`를 묻습니다.
`Cloud only`는 `OLLAMA_API_KEY`와 `https://ollama.com`을 사용합니다.
호스트 기반 모드는 기본 URL(기본값 `http://127.0.0.1:11434`)을 요청하고, 사용 가능한 모델을 검색하며, 기본값을 제안합니다.
`Cloud + Local`은 해당 Ollama 호스트가 cloud 액세스를 위해 로그인되어 있는지도 확인합니다.
자세한 내용: [Ollama](/ko/providers/ollama).
Moonshot (Kimi K2) 및 Kimi Coding 구성은 자동으로 기록됩니다.
자세한 내용: [Moonshot AI (Kimi + Kimi Coding)](/ko/providers/moonshot).
OpenAI 호환 및 Anthropic 호환 엔드포인트와 함께 작동합니다.
대화형 온보딩은 다른 제공자 API 키 흐름과 동일한 API 키 저장 선택지를 지원합니다.
- **지금 API 키 붙여넣기** (일반 텍스트)
- **시크릿 참조 사용** (환경 변수 ref 또는 구성된 provider ref, 사전 검증 포함)
비대화형 플래그:
- `--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`)
인증을 구성하지 않은 상태로 둡니다.
모델 동작:
- 감지된 옵션에서 기본 모델을 선택하거나, 제공자와 모델을 수동으로 입력합니다.
- 온보딩이 제공자 인증 선택에서 시작되면, 모델 선택기는
해당 제공자를 자동으로 우선시합니다. Volcengine 및 BytePlus의 경우, 동일한 우선순위가
해당 coding-plan 변형(
volcengine-plan/*,
byteplus-plan/*)에도 적용됩니다.
- 이 기본 제공자 필터의 결과가 비어 있으면,
모델을 하나도 표시하지 않는 대신 전체 카탈로그로 대체합니다.
- 마법사는 모델 검사를 실행하고 구성된 모델을 알 수 없거나 인증이 누락된 경우 경고합니다.
자격 증명 및 profile 경로:
- Auth profile(API 키 + OAuth):
~/.openclaw/agents/<agentId>/agent/auth-profiles.json
- 레거시 OAuth 가져오기:
~/.openclaw/credentials/oauth.json
자격 증명 저장 모드:
- 기본 온보딩 동작은 API 키를 auth profile에 일반 텍스트 값으로 저장합니다.
--secret-input-mode ref는 일반 텍스트 키 저장 대신 참조 모드를 활성화합니다.
대화형 설정에서는 다음 중 하나를 선택할 수 있습니다.
- 환경 변수 ref(예:
keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
- 구성된 provider ref(
file 또는 exec)와 provider 별칭 + id
- 대화형 참조 모드는 저장 전에 빠른 사전 검증을 실행합니다.
- Env ref: 변수 이름과 현재 온보딩 환경에서 비어 있지 않은 값을 검증합니다.
- Provider ref: provider 구성을 검증하고 요청한 id를 확인합니다.
- 사전 검증이 실패하면 온보딩은 오류를 표시하고 다시 시도할 수 있게 합니다.
- 비대화형 모드에서
--secret-input-mode ref는 env 기반만 지원합니다.
- 온보딩 프로세스 환경에 provider 환경 변수를 설정하세요.
- 인라인 키 플래그(예:
--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>.
- 기존 일반 텍스트 설정은 변경 없이 계속 작동합니다.
헤드리스 및 서버 팁: 브라우저가 있는 컴퓨터에서 OAuth를 완료한 다음, 해당 에이전트의 `auth-profiles.json`(예:
`~/.openclaw/agents//agent/auth-profiles.json` 또는 일치하는
`$OPENCLAW_STATE_DIR/...` 경로)을 gateway 호스트로 복사하세요. `credentials/oauth.json`은
레거시 가져오기 소스일 뿐입니다.
출력 및 내부 동작
~/.openclaw/openclaw.json의 일반적인 필드:
agents.defaults.workspace
agents.defaults.model / models.providers (MiniMax를 선택한 경우)
tools.profile (로컬 온보딩은 설정되지 않은 경우 기본값으로 "coding"을 사용하며, 기존의 명시적 값은 유지됨)
gateway.* (mode, bind, auth, Tailscale)
session.dmScope (로컬 온보딩은 설정되지 않은 경우 기본값으로 per-channel-peer를 사용하며, 기존의 명시적 값은 유지됨)
channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
- 프롬프트 중 옵트인한 경우의 채널 allowlist(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/ 아래에 저장됩니다.
일부 채널은 Plugin으로 제공됩니다. 설정 중 선택하면 마법사는
채널 구성을 시작하기 전에 Plugin 설치(npm 또는 로컬 경로)를 묻습니다.
Gateway 마법사 RPC:
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를 사용하며 WSL 내부에서 Linux
signal-cli 흐름을 따릅니다
관련 문서
- 온보딩 허브: 온보딩 (CLI)
- 자동화 및 스크립트: CLI 자동화
- 명령어 참조:
openclaw onboard