Dashboard Freewrite Whiteboards Projects CRM Tasks Notifications Settings Agent Tower API Docs

?

User

Member

Caricamento in corso...

OpenClaw

Documentation Mirror

Documentation Overview

Docs

Auth credential semantics

Scheduled tasks

Automation & tasks

Standing orders

Background tasks

Broadcast groups

Channel routing

Channel location parsing

Matrix migration

Matrix push rules for quiet previews

Microsoft Teams

Channel troubleshooting

`openclaw commitments`

Flows (redirect)

`openclaw tasks`

Agent workspace

Gateway architecture

Channel docking

Inferred commitments

Delegate architecture

Experimental features

Markdown formatting

Memory overview

Builtin memory engine

QMD memory engine

Model providers

Multi-agent routing

OpenClaw App SDK

Session management

Session pruning

SOUL.md personality guide

Streaming and chunking

Typing indicators

Node + tsx crash

Diagnostics flags

Background exec and process tool

Bonjour discovery

Bridge protocol

Configuration — agents

Configuration — channels

Configuration — tools and custom providers

Configuration examples

Configuration reference

Diagnostics export

Discovery and transports

Gateway runbook

Gateway logging

Multiple gateways

OpenAI chat completions

OpenResponses API

OpenTelemetry export

Gateway-owned pairing

Prometheus metrics

Gateway protocol

Remote gateway setup

Sandbox vs tool policy vs elevated

Secrets management

Secrets apply plan contract

Security audit checks

Tools invoke API

Troubleshooting

Trusted proxy auth

Environment variables

FAQ: first-run setup

FAQ: models and auth

GPT-5.5 / Codex agentic parity

GPT-5.5 / Codex parity maintainer notes

Testing: live suites

General troubleshooting

Bun (experimental)

Release channels

Docker VM runtime

Installer internals

Migration guide

Migrating from Claude

Migrating from Hermes

Audio and voice notes

Image and media support

Location command

Media understanding

Node troubleshooting

Pi integration architecture

Pi development workflow

Gateway on macOS

Gateway lifecycle

macOS dev setup

Health checks (macOS)

Peekaboo bridge

macOS permissions

Voice wake (macOS)

WebChat (macOS)

Plugin internals

Plugin architecture internals

Building plugins

Codex Computer Use

Community plugins

Plugin compatibility

Google Meet plugin

Plugin manifest

Message presentation

Agent harness plugins

Building channel plugins

Channel turn kernel

Plugin entry points

Plugin SDK migration

Plugin SDK overview

Building provider plugins

Plugin runtime helpers

Plugin setup and config

Plugin SDK subpaths

Skill workshop plugin

Voice call plugin

Webhooks plugin

Zalo personal plugin

Alibaba Model Studio

Amazon Bedrock Mantle

Claude Max API proxy

Cloudflare AI gateway

Google (Gemini)

Hugging Face (inference)

Provider directory

Model provider quickstart

Tencent Cloud (TokenHub)

Vercel AI gateway

Volcengine (Doubao)

Default AGENTS.md

API usage and costs

Device model database

Full release validation

Memory configuration reference

OpenClaw App SDK API design

Rich output protocol

SecretRef credential surface

Session management deep dive

AGENTS.md template

BOOT.md template

BOOTSTRAP.md template

HEARTBEAT.md template

IDENTITY template

SOUL.md template

TOOLS.md template

Token use and costs

Transcript hygiene

Onboarding reference

Contributing to the threat model

Threat model (MITRE ATLAS)

Formal verification (security models)

Agent bootstrapping

Getting started

Onboarding (macOS app)

Onboarding overview

Personal assistant setup

Onboarding (CLI)

CLI setup reference

ACP agents — setup

apply_patch tool

Browser (OpenClaw-managed)

Browser control API

Browser troubleshooting

WSL2 + Windows + remote Chrome CDP troubleshooting

BTW side questions

Creating skills

DuckDuckGo search

Exec approvals — advanced

Image generation

Tools and plugins

Tool-loop detection

Multi-agent sandbox and tools

Music generation

Ollama web search

Perplexity search

Thinking levels

Trajectory bundles

Video generation

OpenAPI Specs

TaskFlow

docs/openclaw

Real-time Synchronized Documentation

Last sync: 01/05/2026 07:03:01

Note: This content is mirrored from docs.openclaw.ai and is subject to their terms and conditions.

OpenClaw Docs

v2.4.0 Production

Last synced: Today, 22:00

Technical reference for the OpenClaw framework. Real-time synchronization with the official documentation engine.

Use this file to discover all available pages before exploring further.

Health

text
`openclaw health`

Fetch health from the running Gateway.

Options:

text
--json
: machine-readable output
text
--timeout <ms>
: connection timeout in milliseconds (default
text
10000
)
text
--verbose
: verbose logging
text
--debug
: alias for
text
--verbose

Examples:


bash
openclaw health
openclaw health --json
openclaw health --timeout 2500
openclaw health --verbose
openclaw health --debug

Notes:

Default
text
openclaw health
asks the running gateway for its health snapshot. When the gateway already has a fresh cached snapshot, it can return that cached payload and refresh in the background.
text
--verbose
forces a live probe, prints gateway connection details, and expands the human-readable output across all configured accounts and agents.
Output includes per-agent session stores when multiple agents are configured.

Related

CLI reference
Gateway health

© 2024 TaskFlow Mirror

Powered by TaskFlow Sync Engine