Skip to content

Configuration Reference

Goal: configure validation, sync, security, and plugin hint behavior safely and predictably.

Full Settings Table

SettingTypeDefaultAllowed Range/ValuesPractical Guidance
openclawConfig.zodShadow.enabledbooleantruetrue / falseKeep enabled for richer diagnostics; disable only for focused schema-only debugging.
openclawConfig.sync.ttlHoursnumber61..168Lower for more frequent updates, higher for network-constrained environments.
openclawConfig.sync.manifestUrlstringhttps://raw.githubusercontent.com/jorekai/openclaw-config-vscode/main/schemas/live/manifest.jsonHTTPS URLUse trusted, versioned manifest endpoints only.
openclawConfig.sync.allowedHostsstring[]["raw.githubusercontent.com"]HostnamesKeep strict allowlist. Add hosts only when needed and trusted.
openclawConfig.sync.allowedRepositoriesstring[]["jorekai/openclaw-config-vscode"]owner/repo values or "*"Prefer explicit repositories. Use "*" only in controlled environments.
openclawConfig.codeActions.enabledbooleantruetrue / falseDisable only if you need diagnostics without automatic fix suggestions.
openclawConfig.integrator.strictSecretsbooleanfalsetrue / falseSet to true in CI/hardening phases to fail fast on cleartext secret values.
openclawConfig.integrator.explainOnHoverbooleantruetrue / falseDisable if hover noise is too high for your workflow.
openclawConfig.plugins.metadataUrlstring""HTTPS URL or emptyOptional remote hint layer. Must pass security policy checks.
openclawConfig.plugins.metadataLocalPathstring.openclaw/plugin-hints.jsonWorkspace-relative or absolute pathKeep workspace-relative for team portability.

Security Policy Settings

These settings jointly control whether remote sync content is accepted:

  • openclawConfig.sync.manifestUrl
  • openclawConfig.sync.allowedHosts
  • openclawConfig.sync.allowedRepositories

Behavior summary:

  1. Manifest URL must be HTTPS.
  2. Manifest host must be allowlisted.
  3. Artifact URLs inside manifest must pass host and repository checks.
  4. SHA-256 hash checks must match for downloaded artifacts.
  5. On failure, extension falls back to cache or bundled artifacts.

Configuration Profiles

Safe default profile

json
{
  "openclawConfig.zodShadow.enabled": true,
  "openclawConfig.sync.ttlHours": 6,
  "openclawConfig.sync.manifestUrl": "https://raw.githubusercontent.com/jorekai/openclaw-config-vscode/main/schemas/live/manifest.json",
  "openclawConfig.sync.allowedHosts": [
    "raw.githubusercontent.com"
  ],
  "openclawConfig.sync.allowedRepositories": [
    "jorekai/openclaw-config-vscode"
  ],
  "openclawConfig.codeActions.enabled": true,
  "openclawConfig.integrator.strictSecrets": false,
  "openclawConfig.integrator.explainOnHover": true,
  "openclawConfig.plugins.metadataUrl": "",
  "openclawConfig.plugins.metadataLocalPath": ".openclaw/plugin-hints.json"
}

Strict security/hardening profile

json
{
  "openclawConfig.sync.ttlHours": 1,
  "openclawConfig.sync.allowedHosts": [
    "raw.githubusercontent.com"
  ],
  "openclawConfig.sync.allowedRepositories": [
    "jorekai/openclaw-config-vscode"
  ],
  "openclawConfig.integrator.strictSecrets": true
}

Controlled custom mirror profile

json
{
  "openclawConfig.sync.manifestUrl": "https://raw.githubusercontent.com/jorekai/openclaw-config-vscode/main/schemas/live/manifest.json",
  "openclawConfig.sync.allowedHosts": [
    "raw.githubusercontent.com"
  ],
  "openclawConfig.sync.allowedRepositories": [
    "jorekai/openclaw-config-vscode"
  ]
}

Plugin Metadata Hints

Two optional hint sources are merged:

  1. Remote entries from openclawConfig.plugins.metadataUrl.
  2. Local entries from openclawConfig.plugins.metadataLocalPath.

Precedence behavior:

  • Layers are merged by pattern.
  • Later layers can override existing property hints for same field key.
  • Warnings are emitted to output when loading fails.

Optional property-level value hints:

  • type: expected value type (string, number, integer, boolean, object, array).
  • enumValues: allowed primitive values.
  • examples: suggested primitive example values.
  • defaultValue: preferred default primitive value.

Example .openclaw/plugin-hints.json:

json
{
  "version": 1,
  "entries": [
    {
      "path": "channels.whatsapp.accounts.*",
      "properties": {
        "dynamicMode": {
          "description": "Plugin-specific mode toggle.",
          "type": "string",
          "enumValues": ["strict", "relaxed"],
          "examples": ["strict"],
          "defaultValue": "strict"
        }
      }
    }
  ]
}
  1. Update settings.
  2. Run OpenClaw: Refresh Schema Now.
  3. Run OpenClaw: Show Schema Status.
  4. Confirm expected policy and source values.

MIT Licensed