install

Install

Five commands. Plugin install, configure, secrets, provision, verify.

Requires OpenClaw ≥ 2026.5.7 with the gateway running, Node ≥ 20, and a reachable MariaDB 10.11+.

  1. Install the plugin

    openclaw plugins install clawhub:openclaw-hawkins \
      || openclaw plugins install npm:openclaw-hawkins
  2. Configure non-secrets

    openclaw config set plugins.entries.openclaw-hawkins.config.mariadb.url "mariadb://your-host:3306/hawkins"
    openclaw config set plugins.entries.openclaw-hawkins.config.mariadb.user "hawkins"
    openclaw config set plugins.entries.openclaw-hawkins.config.mariadb.ssl "insecure"
  3. Wire the password into the gateway

    Secrets flow through the gateway environment, not openclaw.json. A 0600 file referenced from a systemd drop-in keeps them off disk and out of logs.

    mkdir -p ~/.openclaw/secrets && chmod 700 ~/.openclaw/secrets
    ( umask 077 && printf 'MARIADB_PASSWORD=%s\nLINEAR_API_KEY=%s\n' \
        "${MARIADB_PASSWORD}" "${LINEAR_API_KEY}" > ~/.openclaw/secrets/hawkins.env )
    
    mkdir -p ~/.config/systemd/user/openclaw-gateway.service.d
    cat > ~/.config/systemd/user/openclaw-gateway.service.d/hawkins.conf <<'EOF'
    [Service]
    EnvironmentFile=%h/.openclaw/secrets/hawkins.env
    EOF
    
    systemctl --user daemon-reload && openclaw gateway restart
  4. Provision schemas, agents, protocol

    Idempotent — skips schemas and agent workspaces that already exist, and won't overwrite an existing HAWKINS_PROTOCOL.md.

    openclaw hawkins setup
  5. Verify

    openclaw plugins inspect openclaw-hawkins --runtime --json \
      | jq '.plugin | { status, toolNames }'
    
    openclaw agent --agent system-agent --json --timeout 90 \
      --message "Call vecna_healthz and return only the JSON."

    Expected: status: "loaded", all 12 toolNames present, and the agent returns { ok: true, db: "up" }.