OpenClawDocs
View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this page

CLI commands

การกำหนดค่า

ตัวช่วยแบบไม่โต้ตอบสำหรับ openclaw.json: รับ/ตั้งค่า/แพตช์/ยกเลิกการตั้งค่าตามพาธ แสดงสคีมา ตรวจสอบความถูกต้อง หรือแสดงพาธของไฟล์ที่ใช้งานอยู่ เรียกใช้ openclaw config โดยไม่มีคำสั่งย่อยเพื่อเปิดวิซาร์ดแบบมีคำแนะนำเดียวกับ openclaw configure

ตัวเลือกระดับราก

OPENCLAW_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tc2VjdGlvbiA8c2VjdGlvbg " type="string"> ตัวกรองส่วนของการตั้งค่าแบบมีคำแนะนำที่ระบุซ้ำได้ เมื่อเรียกใช้ openclaw config โดยไม่มีคำสั่งย่อย

ส่วนที่มีคำแนะนำ: workspace, model, web, gateway, daemon, channels, plugins, skills, health

ตัวอย่าง

bash
openclaw config fileopenclaw config --section modelopenclaw config --section gateway --section daemonopenclaw config schemaopenclaw config get browser.executablePathopenclaw config set browser.executablePath "/usr/bin/google-chrome"openclaw config set browser.profiles.work.executablePath "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"openclaw config set agents.defaults.heartbeat.every "2h"openclaw config set 'agents.list[0].tools.exec.node' "node-id-or-name"openclaw config set agents.defaults.models '{"openai/gpt-5.4":{}}' --strict-json --mergeopenclaw config set channels.discord.token --ref-provider default --ref-source env --ref-id DISCORD_BOT_TOKENopenclaw config set secrets.providers.vaultfile --provider-source file --provider-path /etc/openclaw/secrets.json --provider-mode jsonopenclaw config patch --file ./openclaw.patch.json5 --dry-runopenclaw config unset plugins.entries.brave.config.webSearch.apiKeyopenclaw config set channels.discord.token --ref-provider default --ref-source env --ref-id DISCORD_BOT_TOKEN --dry-runopenclaw config validateopenclaw config validate --json

พาธ

ใช้รูปแบบจุดหรือวงเล็บเหลี่ยม ให้ครอบพาธแบบวงเล็บเหลี่ยมด้วยเครื่องหมายคำพูดในตัวอย่างเชลล์ เพื่อไม่ให้ zsh ขยายแพตเทิร์น [0]:

bash
openclaw config get agents.defaults.workspaceopenclaw config get 'agents.list[0].id'openclaw config get agents.listopenclaw config set 'agents.list[1].tools.exec.node' "node-id-or-name"

config get

อ่านค่าจากสแนปช็อตการกำหนดค่าที่ปกปิดข้อมูลแล้ว (ไม่มีการแสดงข้อมูลลับ) --json จะแสดงค่าดิบเป็น JSON มิฉะนั้นสตริง/ตัวเลข/บูลีนจะแสดงโดยไม่มีการจัดรูปแบบ และออบเจ็กต์/อาร์เรย์จะแสดงเป็น JSON ที่จัดรูปแบบแล้ว

bash
openclaw config get browser.executablePathopenclaw config get agents.defaults.model --json

config file

แสดงพาธของไฟล์การกำหนดค่าที่ใช้งานอยู่ ซึ่งแปลงมาจาก OPENCLAW_CONFIG_PATH หรือตำแหน่งเริ่มต้น พาธนี้ชี้ไปยังไฟล์ปกติ ไม่ใช่ลิงก์สัญลักษณ์ โปรดดู ความปลอดภัยในการเขียน

config schema

แสดงสคีมา JSON ที่สร้างขึ้นสำหรับ openclaw.json ไปยังเอาต์พุตมาตรฐาน

สิ่งที่รวมอยู่
  • สคีมาการกำหนดค่าระดับรากปัจจุบัน พร้อมฟิลด์สตริง $schema ระดับรากสำหรับเครื่องมือของตัวแก้ไข
  • เมทาดาทาเอกสารของฟิลด์ title / description ที่ Control UI ใช้
  • โหนดออบเจ็กต์ซ้อน ไวลด์การ์ด (*) และรายการอาร์เรย์ ([]) จะสืบทอดเมทาดาทา title / description เดียวกัน เมื่อมีเอกสารฟิลด์ที่ตรงกัน
  • สาขา anyOf / oneOf / allOf จะสืบทอดเมทาดาทาเอกสารเดียวกันด้วย
  • เมทาดาทาสคีมาของ Plugin และช่องทางแบบสดตามความสามารถ เมื่อสามารถโหลดไฟล์กำกับรันไทม์ได้
  • สคีมาสำรองที่สะอาด แม้ว่าการกำหนดค่าปัจจุบันจะไม่ถูกต้อง
RPC รันไทม์ที่เกี่ยวข้อง

config.schema.lookup ส่งคืนพาธการกำหนดค่าที่ปรับให้อยู่ในรูปแบบมาตรฐานหนึ่งพาธ พร้อมโหนดสคีมาระดับตื้น (title, description, type, enum, const, ขอบเขตทั่วไป) เมทาดาทาคำแนะนำ UI ที่ตรงกัน และข้อมูลสรุปของโหนดลูกโดยตรง ใช้สำหรับเจาะดูรายละเอียดตามขอบเขตพาธใน Control UI หรือไคลเอนต์ที่กำหนดเอง

bash
openclaw config schemaopenclaw config schema > openclaw.schema.json

config validate

ตรวจสอบการกำหนดค่าปัจจุบันกับสคีมาที่ใช้งานอยู่ โดยไม่เริ่ม Gateway

bash
openclaw config validateopenclaw config validate --json

ค่า

ระบบจะแยกวิเคราะห์ค่าเป็น JSON5 เมื่อทำได้ มิฉะนั้นจะถือเป็นสตริงดิบ ใช้ --strict-json เพื่อบังคับใช้ JSON มาตรฐานโดยไม่มีการย้อนกลับไปใช้สตริง (จากนั้นไวยากรณ์ที่มีเฉพาะใน JSON5 เช่น ความคิดเห็น เครื่องหมายจุลภาคท้ายรายการ หรือคีย์ที่ไม่มีเครื่องหมายคำพูดจะถูกปฏิเสธ) --json เป็นนามแฝงแบบเดิมของ --strict-json สำหรับ config set

bash
openclaw config set agents.defaults.heartbeat.every "0m"openclaw config set gateway.port 19001 --strict-jsonopenclaw config set channels.whatsapp.groups '["*"]' --strict-json

config get <path> --json แสดงค่าดิบเป็น JSON แทนข้อความที่จัดรูปแบบสำหรับเทอร์มินัล

ใช้ --merge เมื่อเพิ่มรายการลงในแมปเหล่านั้น:

bash
openclaw config set agents.defaults.models '{"openai/gpt-5.4":{}}' --strict-json --mergeopenclaw config set models.providers.ollama.models '[{"id":"llama3.2","name":"Llama 3.2"}]' --strict-json --merge

ใช้ --replace เฉพาะเมื่อตั้งใจให้ค่าที่ระบุกลายเป็นค่าเป้าหมายทั้งหมด

โหมดของ config set

โหมดค่า

bash
openclaw config set <path> <value>

โหมดตัวสร้าง SecretRef

bash
openclaw config set channels.discord.token \  --ref-provider default \  --ref-source env \  --ref-id DISCORD_BOT_TOKEN

โหมดตัวสร้างผู้ให้บริการ

กำหนดเป้าหมายได้เฉพาะพาธ secrets.providers.<alias>:

bash
openclaw config set secrets.providers.vault \  --provider-source exec \  --provider-command /usr/local/bin/openclaw-vault \  --provider-arg read \  --provider-arg openai/api-key \  --provider-timeout-ms 5000

โหมดแบตช์

bash
openclaw config set --batch-json '[  {    "path": "secrets.providers.default",    "provider": { "source": "env" }  },  {    "path": "channels.discord.token",    "ref": { "source": "env", "provider": "default", "id": "DISCORD_BOT_TOKEN" }  }]'
bash
openclaw config set --batch-file ./config-set.batch.json --dry-run

การแยกวิเคราะห์แบบแบตช์จะใช้เพย์โหลดแบตช์ (--batch-json/--batch-file) เป็นแหล่งข้อมูลจริงเสมอ --strict-json / --json ไม่เปลี่ยนพฤติกรรมการแยกวิเคราะห์แบบแบตช์

โหมดพาธ/ค่า JSON ยังใช้กับ SecretRef และผู้ให้บริการโดยตรงได้ด้วย:

bash
openclaw config set channels.discord.token \  '{"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}' \  --strict-json openclaw config set secrets.providers.vaultfile \  '{"source":"file","path":"/etc/openclaw/secrets.json","mode":"json"}' \  --strict-json

แฟล็กตัวสร้างผู้ให้บริการ

เป้าหมายของตัวสร้างผู้ให้บริการต้องใช้ secrets.providers.<alias> เป็นพาธ

แฟล็กทั่วไป
  • --provider-source <env|file|exec>
  • --provider-timeout-ms <ms> (file, exec)
ผู้ให้บริการ Env (--provider-source env)
  • --provider-allowlist &lt;ENV_VAR&gt; (ระบุซ้ำได้)
ผู้ให้บริการไฟล์ (--provider-source file)
  • --provider-path <path> (จำเป็น)
  • --provider-mode <singleValue|json>
  • --provider-max-bytes <bytes>
  • --provider-allow-insecure-path
ผู้ให้บริการ Exec (--provider-source exec)
  • --provider-command <path> (จำเป็น)
  • --provider-arg <arg> (ระบุซ้ำได้)
  • --provider-no-output-timeout-ms <ms>
  • --provider-max-output-bytes <bytes>
  • --provider-json-only
  • --provider-env &lt;KEY=VALUE&gt; (ระบุซ้ำได้)
  • --provider-pass-env &lt;ENV_VAR&gt; (ระบุซ้ำได้)
  • --provider-trusted-dir <path> (ระบุซ้ำได้)
  • --provider-allow-insecure-path
  • --provider-allow-symlink-command

ตัวอย่างผู้ให้บริการ exec ที่เพิ่มความปลอดภัย:

bash
openclaw config set secrets.providers.vault \  --provider-source exec \  --provider-command /usr/local/bin/openclaw-vault \  --provider-arg read \  --provider-arg openai/api-key \  --provider-json-only \  --provider-pass-env VAULT_TOKEN \  --provider-trusted-dir /usr/local/bin \  --provider-timeout-ms 5000

config patch

วางหรือส่งแพตช์ JSON5 ที่มีโครงสร้างเหมือนการกำหนดค่าผ่านไพป์ แทนการเรียกใช้คำสั่ง config set ตามพาธหลายคำสั่ง ออบเจ็กต์จะผสานแบบเรียกซ้ำ ส่วนอาร์เรย์และค่าสเกลาร์จะแทนที่เป้าหมาย และ null จะลบพาธเป้าหมาย

bash
openclaw config patch --file ./openclaw.patch.json5 --dry-runopenclaw config patch --file ./openclaw.patch.json5

ส่งแพตช์ผ่านอินพุตมาตรฐานสำหรับสคริปต์ตั้งค่าระยะไกล:

bash
ssh user@gateway-host 'openclaw config patch --stdin --dry-run' < ./openclaw.patch.json5ssh user@gateway-host 'openclaw config patch --stdin' < ./openclaw.patch.json5

ตัวอย่างแพตช์:

json5
{  channels: {    slack: {      enabled: true,      mode: "socket",      botToken: { source: "env", provider: "default", id: "SLACK_BOT_TOKEN" },      appToken: { source: "env", provider: "default", id: "SLACK_APP_TOKEN" },      groupPolicy: "open",      requireMention: false,    },    discord: {      enabled: true,      token: { source: "env", provider: "default", id: "DISCORD_BOT_TOKEN" },      dmPolicy: "disabled",      dm: { enabled: false },      groupPolicy: "allowlist",    },  },  agents: {    defaults: {      model: { primary: "openai/gpt-5.6-sol" },      models: {        "openai/gpt-5.6-sol": { params: { fastMode: true } },      },    },  },}

ใช้ --replace-path <path> เมื่อออบเจ็กต์หรืออาร์เรย์รายการหนึ่งต้องกลายเป็นค่าที่ระบุอย่างตรงทั้งหมด แทนที่จะถูกแพตช์แบบเรียกซ้ำ:

bash
openclaw config patch --file ./discord.patch.json5 --replace-path 'channels.discord.guilds["123"].channels'

--dry-run จะเรียกใช้การตรวจสอบสคีมาและความสามารถในการแก้ค่า SecretRef โดยไม่เขียนข้อมูล โดยค่าเริ่มต้น SecretRef ที่ใช้ exec จะถูกข้ามระหว่างการทดลองเรียกใช้ ให้เพิ่ม --allow-exec เมื่อตั้งใจให้การทดลองเรียกใช้ดำเนินคำสั่งของผู้ให้บริการ

การทดลองเรียกใช้

--dry-run ตรวจสอบความถูกต้องของการเปลี่ยนแปลงโดยไม่เขียน openclaw.json ใช้ได้กับ config set, config patch และ config unset

bash
openclaw config set channels.discord.token \  --ref-provider default \  --ref-source env \  --ref-id DISCORD_BOT_TOKEN \  --dry-run \  --json openclaw config set channels.discord.token \  --ref-provider vault \  --ref-source exec \  --ref-id discord/token \  --dry-run \  --allow-exec
ลักษณะการทำงานของการทดลองรัน
  • โหมด Builder: เรียกใช้การตรวจสอบความสามารถในการแก้ค่า SecretRef สำหรับการอ้างอิง/ผู้ให้บริการที่มีการเปลี่ยนแปลง
  • โหมด JSON (--strict-json, --json หรือโหมดแบตช์): เรียกใช้การตรวจสอบสคีมาร่วมกับการตรวจสอบความสามารถในการแก้ค่า SecretRef
  • การตรวจสอบนโยบายจะดำเนินการกับการกำหนดค่าทั้งหมดหลังการเปลี่ยนแปลง ดังนั้นการเขียนออบเจ็กต์แม่ (เช่น การตั้งค่า hooks เป็นออบเจ็กต์) จึงไม่สามารถหลีกเลี่ยงการตรวจสอบพื้นผิวที่ไม่รองรับได้
  • โดยค่าเริ่มต้น ระบบจะข้ามการตรวจสอบ Exec SecretRef เพื่อหลีกเลี่ยงผลข้างเคียงจากคำสั่ง ให้ส่ง --allow-exec เพื่อเลือกเปิดใช้ (ซึ่งอาจเรียกใช้คำสั่งของผู้ให้บริการ) --allow-exec ใช้ได้เฉพาะกับการทดลองรัน และจะแจ้งข้อผิดพลาดหากไม่มี --dry-run
ฟิลด์ของ --dry-run --json
  • ok: การทดลองรันผ่านหรือไม่
  • operations: จำนวนการกำหนดค่าที่ได้รับการประเมิน
  • checks: มีการเรียกใช้การตรวจสอบสคีมา/ความสามารถในการแก้ค่าหรือไม่
  • checks.resolvabilityComplete: การตรวจสอบความสามารถในการแก้ค่าดำเนินการจนเสร็จสมบูรณ์หรือไม่ (เป็น false เมื่อข้ามการอ้างอิงแบบ exec)
  • refsChecked: จำนวนการอ้างอิงที่แก้ค่าได้จริงระหว่างการทดลองรัน
  • skippedExecRefs: จำนวนการอ้างอิงแบบ exec ที่ถูกข้ามเนื่องจากไม่ได้ตั้งค่า --allow-exec
  • errors: ความล้มเหลวแบบมีโครงสร้างจากพาธที่ไม่มีอยู่ สคีมา หรือความสามารถในการแก้ค่า เมื่อ ok=false

รูปแบบเอาต์พุต JSON

json5
{  ok: boolean,  operations: number,  configPath: string,  inputModes: ["value" | "json" | "builder" | "unset", ...],  checks: {    schema: boolean,    resolvability: boolean,    resolvabilityComplete: boolean,  },  refsChecked: number,  skippedExecRefs: number,  errors?: [    {      kind: "missing-path" | "schema" | "resolvability",      message: string,      ref?: string, // มีอยู่สำหรับข้อผิดพลาดด้านความสามารถในการแก้ค่า    },  ],}

ตัวอย่างที่สำเร็จ

json
{  "ok": true,  "operations": 1,  "configPath": "~/.openclaw/openclaw.json",  "inputModes": ["builder"],  "checks": {    "schema": false,    "resolvability": true,    "resolvabilityComplete": true  },  "refsChecked": 1,  "skippedExecRefs": 0}

ตัวอย่างที่ล้มเหลว

json
{  "ok": false,  "operations": 1,  "configPath": "~/.openclaw/openclaw.json",  "inputModes": ["builder"],  "checks": {    "schema": false,    "resolvability": true,    "resolvabilityComplete": true  },  "refsChecked": 1,  "skippedExecRefs": 0,  "errors": [    {      "kind": "resolvability",      "message": "Error: Environment variable \"MISSING_TEST_SECRET\" is not set.",      "ref": "env:default:MISSING_TEST_SECRET"    }  ]}
หากการทดลองรันล้มเหลว
  • config schema validation failed: รูปแบบการกำหนดค่าหลังการเปลี่ยนแปลงไม่ถูกต้อง ให้แก้ไขพาธ/ค่า หรือรูปแบบออบเจ็กต์ผู้ให้บริการ/การอ้างอิง
  • Config policy validation failed: unsupported SecretRef usage: ย้ายข้อมูลประจำตัวนั้นกลับไปเป็นอินพุตข้อความธรรมดา/สตริง และใช้ SecretRef เฉพาะบนพื้นผิวที่รองรับ
  • SecretRef assignment(s) could not be resolved: ผู้ให้บริการ/การอ้างอิงที่ระบุไม่สามารถแก้ค่าได้ในขณะนี้ (ตัวแปรสภาพแวดล้อมหายไป ตัวชี้ไฟล์ไม่ถูกต้อง ผู้ให้บริการ exec ล้มเหลว หรือผู้ให้บริการ/แหล่งที่มาไม่ตรงกัน)
  • Dry run note: skipped <n> exec SecretRef resolvability check(s): เรียกใช้อีกครั้งพร้อม --allow-exec หากต้องการตรวจสอบความสามารถในการแก้ค่าแบบ exec
  • สำหรับโหมดแบตช์ ให้แก้ไขรายการที่ล้มเหลวและเรียกใช้ --dry-run อีกครั้งก่อนเขียน

การนำการเปลี่ยนแปลงไปใช้

หลังจาก config set / config patch / config unset สำเร็จทุกครั้ง CLI จะแสดงคำแนะนำหนึ่งในสามรายการเพื่อให้ทราบว่า Gateway จำเป็นต้องรีสตาร์ตหรือไม่:

คำแนะนำ ความหมาย
Restart the gateway to apply. พาธที่เปลี่ยนแปลงจำเป็นต้องรีสตาร์ตทั้งหมด
Change will apply without restarting the gateway. การโหลดซ้ำแบบทันทีจะรับการเปลี่ยนแปลงโดยอัตโนมัติ
No gateway restart needed. ไม่มีสิ่งที่เกี่ยวข้องกับรันไทม์เปลี่ยนแปลง

การเขียนไปยัง plugins.entries (หรือพาธย่อยใด ๆ) จำเป็นต้องรีสตาร์ตเสมอ เนื่องจาก CLI ไม่สามารถยืนยันได้ว่ามีการโหลดข้อมูลเมตาการโหลดซ้ำของทุก Plugin แล้ว

ความปลอดภัยในการเขียน

openclaw config set และตัวเขียนการกำหนดค่าอื่น ๆ ที่ OpenClaw เป็นเจ้าของ จะตรวจสอบการกำหนดค่าทั้งหมดหลังการเปลี่ยนแปลงก่อนบันทึกลงดิสก์ หากเพย์โหลดใหม่ไม่ผ่านการตรวจสอบสคีมาหรือดูเหมือนเป็นการเขียนทับที่ทำลายข้อมูล การกำหนดค่าที่ใช้งานอยู่จะไม่ถูกแก้ไข และเพย์โหลดที่ถูกปฏิเสธจะถูกบันทึกไว้ข้างกันในชื่อ openclaw.json.rejected.*

ควรใช้ CLI สำหรับการแก้ไขเล็กน้อย:

bash
openclaw config set gateway.reload.mode hybrid --dry-runopenclaw config set gateway.reload.mode hybridopenclaw config validate

หากการเขียนถูกปฏิเสธ ให้ตรวจสอบเพย์โหลดที่บันทึกไว้และแก้ไขรูปแบบการกำหนดค่าทั้งหมด:

bash
CONFIG="$(openclaw config file)"ls -lt "$CONFIG".rejected.* 2>/dev/null | headopenclaw config validate

ยังคงอนุญาตให้เขียนโดยตรงผ่านตัวแก้ไขได้ แต่ Gateway ที่กำลังทำงานจะถือว่าการเปลี่ยนแปลงเหล่านั้นไม่น่าเชื่อถือจนกว่าจะผ่านการตรวจสอบ การแก้ไขโดยตรงที่ไม่ถูกต้องจะทำให้การเริ่มต้นล้มเหลวหรือถูกข้ามโดยการโหลดซ้ำแบบทันที โดย Gateway จะไม่เขียน openclaw.json ใหม่ เรียกใช้ openclaw doctor --fix เพื่อซ่อมแซมการกำหนดค่าที่มีคำนำหน้าหรือถูกเขียนทับ หรือกู้คืนสำเนาล่าสุดที่ทราบว่าใช้งานได้ โปรดดู การแก้ไขปัญหา Gateway

การกู้คืนทั้งไฟล์สงวนไว้สำหรับการซ่อมแซมโดย doctor การเปลี่ยนแปลงสคีมาของ Plugin หรือความคลาดเคลื่อนของ minHostVersion จะยังคงรายงานข้อผิดพลาดอย่างชัดเจน แทนที่จะย้อนกลับการตั้งค่าผู้ใช้ที่ไม่เกี่ยวข้อง เช่น การกำหนดค่าโมเดล ผู้ให้บริการ โปรไฟล์การตรวจสอบสิทธิ์ ช่องทาง การเปิดเผย Gateway เครื่องมือ หน่วยความจำ เบราว์เซอร์ หรือ Cron

วงรอบการซ่อมแซม

หลังจาก openclaw config validate ผ่านแล้ว ให้ใช้ TUI ภายในเครื่องเพื่อให้เอเจนต์แบบฝังตัวเปรียบเทียบการกำหนดค่าที่ใช้งานอยู่กับเอกสาร ขณะที่คุณตรวจสอบการเปลี่ยนแปลงแต่ละรายการจากเทอร์มินัลเดียวกัน:

bash
openclaw chat

ภายใน TUI เครื่องหมาย ! ที่นำหน้าจะเรียกใช้คำสั่งเชลล์ภายในเครื่องตามตัวอักษร (หลังจากยืนยันหนึ่งครั้งต่อเซสชัน):

text
!openclaw config file!openclaw docs gateway auth token secretref!openclaw config validate!openclaw doctor

  • เปรียบเทียบกับเอกสาร

    ขอให้เอเจนต์เปรียบเทียบการกำหนดค่าปัจจุบันกับหน้าเอกสารที่เกี่ยวข้อง และแนะนำการแก้ไขที่เล็กที่สุด

  • ใช้การแก้ไขเฉพาะจุด

    ใช้การแก้ไขเฉพาะจุดด้วย openclaw config set หรือ openclaw configure

  • ตรวจสอบอีกครั้ง

    เรียกใช้ openclaw config validate อีกครั้งหลังการเปลี่ยนแปลงแต่ละครั้ง

  • ใช้ doctor สำหรับปัญหารันไทม์

    หากการตรวจสอบผ่านแต่รันไทม์ยังคงมีปัญหา ให้เรียกใช้ openclaw doctor หรือ openclaw doctor --fix เพื่อรับความช่วยเหลือด้านการย้ายข้อมูลและการซ่อมแซม

    • ที่เกี่ยวข้อง

    Was this useful?
    On this page

    On this page