Installing the Faramesh Plugin

Prerequisites

OpenClaw installed and running
Python 3.9+ (for the Faramesh server)
Node.js 18+ (for the OpenClaw plugin)

Step 1: Install the Faramesh server

Or with Docker:

docker run -p 8000

docker run -p 8000

docker run -p 8000

Step 2: Start the Faramesh server

The server starts at http://127.0.0.1:8000. You should see the Faramesh console when you open this URL in your browser.

Step 3: Install the OpenClaw plugin

Option A: Via OpenClaw CLI

Option B: Via npm

npm

npm

npm

Then add to your OpenClaw configuration:

{
  "plugins": ["@faramesh/openclaw"]
}

{
  "plugins": ["@faramesh/openclaw"]
}

{
  "plugins": ["@faramesh/openclaw"]
}

Option C: Local plugin (development)

Clone or copy the plugin into your OpenClaw extensions directory:

Step 4: Configure the plugin (optional)

The plugin works with defaults (connects to http://127.0.0.1:8000). To customize:

{
  "plugins": {
    "@faramesh/openclaw": {
      "base_url": "http://127.0.0.1:8000",
      "timeout_ms": 5000,
      "fail_closed": true,
      "api_key": "your-api-key"
    }
  }
}

{
  "plugins": {
    "@faramesh/openclaw": {
      "base_url": "http://127.0.0.1:8000",
      "timeout_ms": 5000,
      "fail_closed": true,
      "api_key": "your-api-key"
    }
  }
}

{
  "plugins": {
    "@faramesh/openclaw": {
      "base_url": "http://127.0.0.1:8000",
      "timeout_ms": 5000,
      "fail_closed": true,
      "api_key": "your-api-key"
    }
  }
}

Or via environment variables:

export FARAMESH_BASE_URL=http://127.0.0.1:8000
export FARAMESH_API_KEY

export FARAMESH_BASE_URL=http://127.0.0.1:8000
export FARAMESH_API_KEY

export FARAMESH_BASE_URL=http://127.0.0.1:8000
export FARAMESH_API_KEY

Configuration options

Option	Default	Description
`base_url`	`http://127.0.0.1:8000`	Faramesh server URL
`timeout_ms`	`5000`	Timeout for Faramesh API calls (milliseconds)
`fail_closed`	`true`	Block tool calls when Faramesh is unreachable
`agent_id_override`	Session agent ID	Override the agent ID sent to Faramesh
`api_key`	None	API key for Faramesh authentication

Step 5: Start the client dashboard (optional)

cd client
npm install
npm

cd client
npm install
npm

cd client
npm install
npm

The full governance dashboard opens at http://0.0.0.0:3000.

Verify installation

# Check server status
faramesh status

# Should show:
#   Server:    ✅ Running at http://127.0.0.1:8000
#   Slack:     ❌ Not configured
#   Email:     ❌ Not configured
#   Policy:    bash=ask, filesystem=ask, browser=allow, ...

# Check server status
faramesh status

# Should show:
#   Server:    ✅ Running at http://127.0.0.1:8000
#   Slack:     ❌ Not configured
#   Email:     ❌ Not configured
#   Policy:    bash=ask, filesystem=ask, browser=allow, ...

# Check server status
faramesh status

# Should show:
#   Server:    ✅ Running at http://127.0.0.1:8000
#   Slack:     ❌ Not configured
#   Email:     ❌ Not configured
#   Policy:    bash=ask, filesystem=ask, browser=allow, ...

Run a tool call in OpenClaw, it should appear in the Faramesh dashboard.

Table of content