ข้อมูลอ้างอิงการตั้งค่า CLI

หน้านี้เป็นเอกสารอ้างอิงฉบับเต็มสำหรับ openclaw onboard สำหรับคู่มือแบบสั้น โปรดดู การเริ่มใช้งาน (CLI)

# วิซาร์ดทำอะไร

โหมดภายในเครื่อง (ค่าเริ่มต้น) จะแนะนำคุณผ่าน:

• การตั้งค่าโมเดลและการรับรองความถูกต้อง (OAuth สำหรับการสมัครใช้งาน OpenAI Code, Anthropic Claude CLI หรือ API key รวมถึงตัวเลือก MiniMax, GLM, Ollama, Moonshot, StepFun และ AI Gateway)
• ตำแหน่งเวิร์กสเปซและไฟล์บูตสแตรป
• การตั้งค่า Gateway (พอร์ต, การ bind, การรับรองความถูกต้อง, Tailscale)
• ช่องทางและผู้ให้บริการ (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, BlueBubbles และ Plugin ช่องทางที่บันเดิลมาอื่นๆ)
• การติดตั้ง daemon (LaunchAgent, systemd user unit หรือ Windows Scheduled Task แบบเนทีฟพร้อมทางเลือกสำรองเป็น Startup-folder)
• การตรวจสุขภาพ
• การตั้งค่า Skills

โหมดระยะไกลจะกำหนดค่าเครื่องนี้ให้เชื่อมต่อกับ Gateway ที่อยู่ที่อื่น โหมดนี้จะไม่ติดตั้งหรือแก้ไขสิ่งใดบนโฮสต์ระยะไกล

# รายละเอียดโฟลว์ภายในเครื่อง

# รายละเอียดโหมดระยะไกล

โหมดระยะไกลจะกำหนดค่าเครื่องนี้ให้เชื่อมต่อกับ Gateway ที่อยู่ที่อื่น

สิ่งที่คุณตั้งค่า:

• URL ของ Gateway ระยะไกล (ws://...)
• โทเค็นหาก Gateway ระยะไกลต้องมีการรับรองความถูกต้อง (แนะนำ)

# ตัวเลือกการรับรองความถูกต้องและโมเดล

พฤติกรรมของโมเดล:

• เลือกโมเดลเริ่มต้นจากตัวเลือกที่ตรวจพบ หรือป้อนผู้ให้บริการและโมเดลด้วยตนเอง
• การเริ่มใช้งานผู้ให้บริการแบบกำหนดเองจะอนุมานการรองรับรูปภาพสำหรับ ID โมเดลทั่วไป และถามเฉพาะเมื่อไม่รู้จักชื่อโมเดล
• เมื่อการเริ่มใช้งานเริ่มจากตัวเลือกการรับรองความถูกต้องของผู้ให้บริการ ตัวเลือกโมเดลจะให้ความสำคัญกับ ผู้ให้บริการนั้นโดยอัตโนมัติ สำหรับ Volcengine และ BytePlus ความชอบเดียวกัน ยังจับคู่กับตัวแปร coding-plan ของพวกเขาด้วย (volcengine-plan/*, byteplus-plan/*)
• หากตัวกรองผู้ให้บริการที่ต้องการนั้นจะว่าง ตัวเลือกจะถอยกลับไปใช้ แค็ตตาล็อกเต็มแทนการแสดงว่าไม่มีโมเดล
• วิซาร์ดจะรันการตรวจสอบโมเดลและเตือนหากโมเดลที่กำหนดค่าไว้ไม่รู้จักหรือไม่มีการรับรองความถูกต้อง

เส้นทางข้อมูลรับรองและโปรไฟล์:

• โปรไฟล์การรับรองความถูกต้อง (API keys + OAuth): ~/.openclaw/agents/<agentId>/agent/auth-profiles.json
• การนำเข้า OAuth แบบเดิม: ~/.openclaw/credentials/oauth.json

โหมดการจัดเก็บข้อมูลรับรอง:

• พฤติกรรมเริ่มต้นของการเริ่มใช้งานจะคง API keys เป็นค่าข้อความธรรมดาในโปรไฟล์การรับรองความถูกต้อง
• --secret-input-mode ref เปิดใช้โหมดอ้างอิงแทนการจัดเก็บคีย์แบบข้อความธรรมดา ในการตั้งค่าแบบโต้ตอบ คุณสามารถเลือกอย่างใดอย่างหนึ่ง:
  • env ref ของตัวแปรสภาพแวดล้อม (เช่น keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • provider ref ที่กำหนดค่าไว้ (file หรือ exec) พร้อม alias ของผู้ให้บริการ + id
• โหมดอ้างอิงแบบโต้ตอบจะรันการตรวจสอบ preflight อย่างรวดเร็วก่อนบันทึก
  • Env refs: ตรวจสอบชื่อตัวแปร + ค่าที่ไม่ว่างในสภาพแวดล้อมการเริ่มใช้งานปัจจุบัน
  • Provider refs: ตรวจสอบคอนฟิกผู้ให้บริการและ resolve id ที่ร้องขอ
  • หาก preflight ล้มเหลว การเริ่มใช้งานจะแสดงข้อผิดพลาดและให้คุณลองอีกครั้ง
• ในโหมดไม่โต้ตอบ --secret-input-mode ref รองรับด้วย env เท่านั้น
  • ตั้งค่าตัวแปรสภาพแวดล้อมของผู้ให้บริการในสภาพแวดล้อมกระบวนการเริ่มใช้งาน
  • แฟล็กคีย์แบบ inline (เช่น --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>
• การตั้งค่าแบบข้อความธรรมดาที่มีอยู่จะยังคงทำงานเหมือนเดิม

# เอาต์พุตและรายละเอียดภายใน

ฟิลด์ทั่วไปใน ~/.openclaw/openclaw.json:

• agents.defaults.workspace
• agents.defaults.skipBootstrap เมื่อส่ง --skip-bootstrap
• agents.defaults.model / models.providers (หากเลือก Minimax)
• tools.profile (การเริ่มต้นใช้งานภายในเครื่องมีค่าเริ่มต้นเป็น "coding" เมื่อยังไม่ได้ตั้งค่า; ค่าที่ระบุไว้แล้วจะถูกเก็บไว้)
• gateway.* (โหมด, bind, auth, 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:

• ดาวน์โหลด release asset ที่เหมาะสม
• จัดเก็บไว้ใต้ ~/.openclaw/tools/signal-cli/<version>/
• เขียน channels.signal.cliPath ในการกำหนดค่า
• บิลด์ JVM ต้องใช้ Java 21
• ใช้บิลด์เนทีฟเมื่อมีให้ใช้งาน
• Windows ใช้ WSL2 และทำตามโฟลว์ signal-cli ของ Linux ภายใน WSL

# เอกสารที่เกี่ยวข้อง

• ศูนย์กลางการเริ่มต้นใช้งาน: การเริ่มต้นใช้งาน (CLI)
• ระบบอัตโนมัติและสคริปต์: ระบบอัตโนมัติของ CLI
• ข้อมูลอ้างอิงคำสั่ง: openclaw onboard