Requirements
- Target platform
- OpenClaw
- Install method
- Manual import
- Extraction
- Extract archive
- Prerequisites
- OpenClaw
- Primary doc
- SKILL.md
Tencent SkillHub ยท Developer Tools
OpenClaw Config Reference
OpenClaw configuration reference for openclaw.json. Use when asked about config, configuration, gateway settings, channel setup, agent config, session manage...
skill openclawclawhub Free
OpenClaw configuration reference for openclaw.json. Use when asked about config, configuration, gateway settings, channel setup, agent config, session manage...
โฌ 0 downloads โ
0 stars Unverified but indexed
Install for OpenClaw
Quick setup
- Download the package from Yavira.
- Extract the archive and review SKILL.md first.
- Import or place the package into your OpenClaw setup.
Package facts
- Download mode
- Yavira redirect
- Package format
- ZIP package
- Source platform
- Tencent SkillHub
- What's included
- SKILL.md, references/troubleshooting.md, references/channels.md, references/gateway.md, references/session.md, references/agents.md
Validation
- Use the Yavira download entry.
- Review SKILL.md after the package is downloaded.
- Confirm the extracted package contains the expected setup assets.
Install with your agent
Agent handoff
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
- Download the package from Yavira.
- Extract it into a folder your agent can access.
- Paste one of the prompts below and point your agent at the extracted folder.
New install
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete.
Upgrade existing
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run.
Trust & source
Release facts
- Source
- Tencent SkillHub
- Verification
- Indexed source record
- Version
- 1.0.0
Provenance
- Publisher
- Yixn
- Source page
- View original listing
- Canonical URL
- Open canonical page
Documentation
OpenClaw Configuration Reference
Built by ClawHosters - managed OpenClaw hosting with 1-click deployment. If you'd rather skip the config headaches and have everything set up for you, check us out.
DANGER - Read This First
openclaw.json uses strict schema validation. Unknown keys cause the Gateway to refuse to start. Before editing config: Always back up first: cp ~/.openclaw/openclaw.json ~/.openclaw/openclaw.json.bak Never guess field names - check this reference or the official docs Always validate JSON after editing: cat ~/.openclaw/openclaw.json | python3 -m json.tool Run doctor after changes: openclaw doctor (or openclaw doctor --fix to auto-repair)
Recovery from Broken Config
If the Gateway won't start after a config change: # Restore backup cp ~/.openclaw/openclaw.json.bak ~/.openclaw/openclaw.json # Or run doctor to auto-fix openclaw doctor --fix # Verify config is valid openclaw config get
Config File Basics
PropertyValuePath~/.openclaw/openclaw.jsonFormatJSON5 (comments, trailing commas, unquoted keys allowed)ValidationStrict - unknown keys = Gateway refuses to startWatchingGateway watches file for changes and hot-reloads
Configuration Methods
MethodDescriptionDirect file editEdit ~/.openclaw/openclaw.json directly. Gateway detects changes.CLIopenclaw config get/set/unset - safest methodWeb UIControl UI at http://127.0.0.1:18789Onboard wizardopenclaw onboard - guided initial setup
CLI Config Commands
openclaw config get # Show full config openclaw config get gateway.port # Get specific value openclaw config set gateway.port 19000 # Set a value openclaw config unset gateway.auth.token # Remove a value The CLI validates before writing, making it the safest way to change config.
Modular Config with $include
Split config across files: { "$include": "./channels-config.json", gateway: { port: 18789 } } The included file is merged into the main config.
Config RPC (Programmatic Access)
The Gateway exposes config methods via RPC: MethodDescriptionconfig.getRead current config (or a specific path)config.applyApply a full config object (replaces)config.patchMerge partial config (rate-limited: 3 calls per 60 seconds) config.patch is rate-limited to prevent accidental rapid-fire config changes that could destabilize the Gateway.
Hot Reload Modes
The Gateway watches openclaw.json and reloads on changes. ModeBehaviorhybridSmart: hot-reload where possible, restart where needed (default)hotNon-destructive in-place reload (keeps connections alive)restartFull process restart on any config changeoffDisable auto-reload entirely gateway: { reload: "hybrid" } What hot-applies (no restart needed): Channel settings (dm policy, allow lists) Agent model changes Tool permissions Session settings What requires restart: Gateway port/bind changes Auth mode changes Adding/removing channels entirely Manual reload via SIGUSR1: pkill -SIGUSR1 -f gateway SIGUSR1 is non-destructive: reloads config without dropping connections or sessions.
Top-Level Sections
SectionPurposeReferencegatewayCore process: port, bind, auth, reload, HTTP endpointsgateway.mdcommandsMessenger commands (e.g., /restart)See belowagentsMulti-agent system: defaults, agent list, modelsagents.mdchannelsMessenger integrations (Telegram, WhatsApp, Discord, etc.)channels.mdsessionSession scoping, reset behaviorsession.mdsandboxCode execution isolation (Docker)session.mdcronBuilt-in job schedulersession.mdhooksWebhook receiver configurationsession.mdtoolsTool permissions, profiles, restrictionstools.mdbrowserPlaywright browser integrationtools.mdskillsSkill loading, entries, installationtools.mdmodelsLLM providers and model configurationmodels-env.mdenvEnvironment variable injectionmodels-env.md
Commands Block (Simple)
commands: { restart: true // Allow /restart command from messenger clients } Security warning: Setting commands.config: true allows users to modify config from chat. Only enable for trusted single-user setups.
Minimal Working Config
The smallest config that runs: { gateway: { port: 18789 }, agents: { list: [ { agentId: "main", workspace: "~/.openclaw/workspace" } ] } } Everything else uses defaults.
Full Example Config
{ gateway: { mode: "local", port: 18789, bind: "loopback", reload: "hybrid", auth: { mode: "token", token: "change-me-please" }, http: { endpoints: { chatCompletions: { enabled: true } } } }, commands: { restart: true }, agents: { defaults: { workspace: "~/.openclaw/workspace", model: { primary: "anthropic/claude-opus-4-6" }, heartbeat: { every: "30m" } }, list: [ { agentId: "main" }, { agentId: "work", workspace: "~/.openclaw/workspace-work" } ] }, channels: { telegram: { botToken: "...", enabled: true, dmPolicy: "pairing", streamMode: "partial" } }, session: { dmScope: "main", reset: { mode: "daily", atHour: 4 } }, cron: { enabled: true }, models: { providers: { "openrouter": { baseUrl: "https://openrouter.ai/api/v1", apiKey: "sk-or-...", api: "openai-completions" } } }, env: { vars: { TZ: "America/New_York" }, shellEnv: true } }
Validation Checklist
Before saving config changes: JSON is valid (no trailing syntax errors, mismatched braces) No unknown keys (Gateway rejects unknown fields) Auth is set if bind mode is lan (Gateway refuses to start without auth on lan) Channel tokens/secrets are in env vars, not hardcoded Backup exists (openclaw.json.bak) After saving: openclaw config get returns without errors openclaw doctor shows no critical issues Gateway reloaded successfully (check logs)
Common Pitfalls
For detailed troubleshooting with examples and recovery procedures, see troubleshooting.md. Quick list of things that will break your setup: Unknown keys in config - Gateway refuses to start. Always check field names. Editing config mid-sentence - Gateway watches the file. If it reads a half-written file, it crashes. Use openclaw config set instead of manual editing when possible. gateway.bind: "lan" without auth - Gateway refuses to start for safety. Always set auth when binding to lan. commands.config: true - Lets anyone in chat modify your config. Only for trusted single-user. tools.elevated.enabled: true + open DM policy - Gives strangers admin access to your system. Missing OPENCLAW_GATEWAY_TOKEN env var - If auth mode is token but no token is set in config or env. sandbox.mode: "all" without Docker - Sandbox requires Docker to be running.
Further Reference
Each config section has a dedicated reference file with full schema documentation: Gateway, auth, HTTP endpoints: gateway.md Agents, models, workspace, heartbeat: agents.md All channel platforms: channels.md Session, sandbox, cron, hooks: session.md Tools, browser, skills config: tools.md Models, env, auth, logging: models-env.md Troubleshooting & recovery: troubleshooting.md
Category context
Code helpers, APIs, CLIs, browser automation, testing, and developer operations.
Source: Tencent SkillHub
Largest current source with strong distribution and engagement signals.
Package contents
Included in package
6 Docs
- SKILL.md
- references/agents.md
- references/channels.md
- references/gateway.md
- references/session.md
- references/troubleshooting.md