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

​

คู่มือที่เกี่ยวข้อง

​

ตัวอย่าง

openclaw onboard
openclaw onboard --modern
openclaw onboard --flow quickstart
openclaw onboard --flow manual
openclaw onboard --flow import
openclaw onboard --import-from hermes --import-source ~/.hermes
openclaw onboard --skip-bootstrap
openclaw onboard --mode remote --remote-url wss://gateway-host:18789

openclaw onboard --non-interactive \
  --auth-choice custom-api-key \
  --custom-base-url "https://llm.example.com/v1" \
  --custom-model-id "foo-large" \
  --custom-api-key "$CUSTOM_API_KEY" \
  --secret-input-mode plaintext \
  --custom-compatibility openai \
  --custom-image-input

openclaw onboard --non-interactive \
  --auth-choice lmstudio \
  --custom-base-url "http://localhost:1234/v1" \
  --custom-model-id "qwen/qwen3.5-9b" \
  --lmstudio-api-key "$LM_API_TOKEN" \
  --accept-risk

openclaw onboard --non-interactive \
  --auth-choice ollama \
  --custom-base-url "http://ollama-host:11434" \
  --custom-model-id "qwen3.5:27b" \
  --accept-risk

openclaw onboard --non-interactive \
  --auth-choice openai-api-key \
  --secret-input-mode ref \
  --accept-risk

• ตั้งค่า env var ของผู้ให้บริการใน environment ของกระบวนการตั้งค่าเริ่มต้น (เช่น OPENAI_API_KEY)
• อย่าส่งแฟล็กคีย์แบบ inline (เช่น --openai-api-key) เว้นแต่ว่า env var นั้นถูกตั้งค่าไว้ด้วย
• หากส่งแฟล็กคีย์แบบ inline โดยไม่มี env var ที่จำเป็น การตั้งค่าเริ่มต้นจะล้มเหลวทันทีพร้อมคำแนะนำ

• --gateway-auth token --gateway-token <token> จัดเก็บโทเค็นแบบ plaintext
• --gateway-auth token --gateway-token-ref-env <name> จัดเก็บ gateway.auth.token เป็น env SecretRef
• --gateway-token และ --gateway-token-ref-env ใช้ร่วมกันไม่ได้
• --gateway-token-ref-env ต้องมี env var ที่ไม่ว่างใน environment ของกระบวนการตั้งค่าเริ่มต้น
• เมื่อใช้ --install-daemon หาก token auth ต้องใช้โทเค็น โทเค็น Gateway ที่จัดการด้วย SecretRef จะถูกตรวจสอบความถูกต้อง แต่จะไม่ถูกบันทึกเป็น plaintext ที่ resolve แล้วใน metadata ของ environment บริการ supervisor
• เมื่อใช้ --install-daemon หากโหมดโทเค็นต้องใช้โทเค็นและ SecretRef ของโทเค็นที่กำหนดไว้ยัง resolve ไม่ได้ การตั้งค่าเริ่มต้นจะ fail closed พร้อมคำแนะนำการแก้ไข
• เมื่อใช้ --install-daemon หากมีทั้ง gateway.auth.token และ gateway.auth.password ถูกกำหนดไว้ และ gateway.auth.mode ไม่ได้ตั้งค่า การตั้งค่าเริ่มต้นจะบล็อกการติดตั้งจนกว่าจะตั้งค่า mode อย่างชัดเจน
• การตั้งค่าเริ่มต้นแบบโลคัลจะเขียน gateway.mode="local" ลงใน config หากไฟล์ config ภายหลังไม่มี gateway.mode ให้ถือว่าเป็น config ที่เสียหายหรือการแก้ไขด้วยตนเองที่ไม่สมบูรณ์ ไม่ใช่ทางลัด local-mode ที่ถูกต้อง
• การตั้งค่าเริ่มต้นแบบโลคัลจะติดตั้ง Plugin ที่ดาวน์โหลดได้ซึ่งเลือกไว้ เมื่อเส้นทางการตั้งค่าที่เลือกต้องใช้
• การตั้งค่าเริ่มต้นแบบรีโมตจะเขียนเฉพาะข้อมูลการเชื่อมต่อสำหรับ Gateway รีโมต และไม่ติดตั้งแพ็กเกจ Plugin โลคัล
• --allow-unconfigured เป็น escape hatch สำหรับรันไทม์ Gateway แยกต่างหาก ไม่ได้หมายความว่าการตั้งค่าเริ่มต้นสามารถละ gateway.mode ได้

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 \
  --accept-risk

• เว้นแต่คุณจะส่ง --skip-health การตั้งค่าเริ่มต้นจะรอให้ Gateway โลคัลเข้าถึงได้ก่อนจึงจะออกสำเร็จ
• --install-daemon จะเริ่มเส้นทางการติดตั้ง Gateway แบบจัดการก่อน หากไม่มี คุณต้องมี Gateway โลคัลที่ทำงานอยู่แล้ว เช่น openclaw gateway run
• หากคุณต้องการเพียงการเขียน config/workspace/bootstrap ในระบบอัตโนมัติ ให้ใช้ --skip-health
• หากคุณจัดการไฟล์พื้นที่ทำงานเอง ให้ส่ง --skip-bootstrap เพื่อตั้งค่า agents.defaults.skipBootstrap: true และข้ามการสร้าง AGENTS.md, SOUL.md, TOOLS.md, IDENTITY.md, USER.md, HEARTBEAT.md และ BOOTSTRAP.md
• บน Windows แบบ native, --install-daemon จะลอง Scheduled Tasks ก่อน และ fallback ไปยังรายการเข้าสู่ระบบในโฟลเดอร์ Startup ระดับผู้ใช้ หากการสร้าง task ถูกปฏิเสธ

• เลือก ใช้การอ้างอิง secret เมื่อระบบถาม
• จากนั้นเลือกอย่างใดอย่างหนึ่ง:
  • Environment variable
  • ผู้ให้บริการ secret ที่กำหนดค่าไว้ (file หรือ exec)
• การตั้งค่าเริ่มต้นจะตรวจสอบ preflight อย่างรวดเร็วก่อนบันทึก ref
  • หากการตรวจสอบล้มเหลว การตั้งค่าเริ่มต้นจะแสดงข้อผิดพลาดและให้คุณลองใหม่

​

ตัวเลือก endpoint ของ Z.AI แบบไม่โต้ตอบ

# Promptless endpoint selection
openclaw onboard --non-interactive \
  --auth-choice zai-coding-global \
  --zai-api-key "$ZAI_API_KEY"

# Other Z.AI endpoint choices:
# --auth-choice zai-coding-cn
# --auth-choice zai-global
# --auth-choice zai-cn

openclaw onboard --non-interactive \
  --auth-choice mistral-api-key \
  --mistral-api-key "$MISTRAL_API_KEY"

​

หมายเหตุของโฟลว์

​

คำสั่งติดตามผลทั่วไป

openclaw channels add
openclaw configure
openclaw agents add <name>