Skip to content

Command Reference

The examples below assume the OpenClaw global CLI. On QClaw, replace openclaw with the wrapper QClaw provides.

Auth

bash
openclaw ntf auth set-api-key "ock_xxx"
openclaw ntf auth show
openclaw ntf auth clear

set-token is a compatibility alias for set-api-key (a legacy name); the two behave identically. The api-key is written to credentials.json in the host state directory (mode 0600), and multiple keys are supported (apiKeys[], with one flagged default); the YOOOCLAW_API_KEY environment variable overrides whatever is in the file.

bash
openclaw ntf search
openclaw ntf search --app wechat --from 2026-03-01T00:00:00+08:00 --to 2026-03-09T23:59:59+08:00
openclaw ntf search --keyword "meeting" --limit 20
openclaw ntf search --sender "Zhang San"
openclaw ntf summary --limit 700
openclaw ntf stats --dim app --from 2026-03-01

Notification sync

bash
openclaw ntf sync scan
openclaw ntf sync fetch --date 2026-03-09
openclaw ntf sync commit --date 2026-03-09

Notification monitors

bash
openclaw ntf monitor create boss-alert \
  --description "Monitor important WeChat messages" \
  --match-rules '{"appName":"wechat","senderKeywords":["Boss Zhang"]}' \
  --schedule "*/30 * * * *"

openclaw ntf monitor list
openclaw ntf monitor show boss-alert
openclaw ntf monitor enable boss-alert
openclaw ntf monitor disable boss-alert
openclaw ntf monitor delete boss-alert --yes

Recordings

bash
openclaw ntf rec list
openclaw ntf rec status <recording-id>
openclaw ntf rec storage-path
openclaw ntf rec setup

Light control

bash
openclaw ntf light setup-tools
openclaw ntf light send \
  --segments '[{"mode":"wave","duration_s":4,"brightness":192,"color":{"r":255,"g":0,"b":0}}]'

light send supports at most MAX_LIGHT_SEGMENTS segments (exceeding it raises light_control supports 1-N segments), and repeat_times must be a non-negative integer.

Switching environments

bash
openclaw ntf env show             # current environment (development / test / production) and its endpoints
openclaw ntf env switch test      # switch environment; triggers a gateway reload automatically

Switching to a nonexistent environment name fails with 无效的环境名称: <env>,可选值: development, test, production without affecting the current environment.

Diagnostics & ops

bash
openclaw ntf doctor
openclaw ntf doctor --json
openclaw ntf doctor --fix         # auto-fix whatever can be auto-fixed (state-dir permission bits, dangerous flags)
openclaw ntf storage-path
openclaw ntf tunnel-status
openclaw ntf log --keyword error
openclaw ntf log --keyword relay --from 2026-03-01 --to 2026-03-09 --limit 100
openclaw ntf update
openclaw ntf update --beta        # switch to the beta channel; beta builds don't redact logs, useful for debugging