Skip to content

Getting Started

This site covers three things that share the same underlying notification / recording / light-rule implementation, but whose runtime paths are mutually exclusive — figure out which one you want before you install anything:

Standalone CLIOpenClaw PluginHermes Plugin
What it isStandalone yoooclaw / yc command line with its own local daemonAn OpenClaw / QClaw host plugin, @yoooclaw/phone-notificationsA Python plugin for Hermes Agent, yoooclaw-hermes-plugin
Where it runsA standalone process, no host app requiredInside an OpenClaw / QClaw host you already haveInside a Hermes Agent you already have
Who drives itYou, from a terminal, or an Agent (Claude Code / Codex, etc.)The host's Agent, via openclaw ntf subcommandsHermes' tools / hooks / slash commands
Phone app chatNot supported — the CLI has no chat UISupported — provided by the OpenClaw / QClaw host itself; the plugin just adds notification/recording/light features on topSupported — the plugin ships its own APP adapter, giving Hermes (which otherwise has no phone-facing channel) a chat surface
Read nextStandalone CLIOpenClaw PluginHermes Plugin

Which one should I pick?

  • Just want to drive notifications, recordings, and light control from a terminal / an Agent, with no host app required → install the standalone CLI and jump to Standalone CLI quickstart below.
  • Already running an OpenClaw / QClaw host (which already lets you chat in the app) and want it to also receive phone notifications and control lights via rules → install the OpenClaw plugin and jump to OpenClaw plugin quickstart below.
  • Running Hermes Agent and want to open the phone app and chat with it directly, while also reusing notification / recording / light-rule features → install the Hermes plugin and jump to Hermes plugin quickstart below.

Don't install more than one

All three share the same Relay tunnel implementation and the same local storage — enabling more than one at once means they'll fight over the same connection. Pick one form; don't run the CLI and a plugin side by side. The Hermes plugin enforces this for storage: while it holds the lock, yoooclaw daemon start is refused outright (YOOOCLAW_DAEMON_DISABLED_BY_PLUGIN).

Standalone CLI quickstart

Ships its own local daemon, doesn't require the host app to be online, and abstracts phone notifications, recordings, images, light rules, tunnels, and monitoring into an Agent-Native command suite with a unified --format output and error contract.

PackageStatusDescription
@yoooclaw/cliAvailableThe standalone yoooclaw / yc CLI: ships its own daemon; config / notification / recording / image / light-rule / tunnel / monitor commands are all implemented, with a unified --format output and error contract, Agent-Native.

Prerequisites

  • Installing via npm: Node.js >= 18 (only used to start the thin launcher; the actual work is done by the native Go binary)
  • Installing directly via install.sh (served from Alibaba Cloud OSS) / GitHub Release: no Node required
  • Building from source: the Go toolchain; currently verified locally with Go 1.26.4
  • ASR: the current Go beta only supports cloud api / model-proxy mode; no local Whisper needed
  • Platforms: the npm channel supports x64+arm64 on darwin/linux plus win32-x64; native direct install supports x64+arm64 on darwin/linux. On Windows, credentials are stored in plaintext and the daemon shuts down gracefully over HTTP — see the CLI overview for details.

Install example:

bash
# npm channel
npm i -g @yoooclaw/cli
yoooclaw --help

# or the native binary (no Node required, served from Alibaba Cloud OSS)
curl -fsSL https://artifact.yoooclaw.com/cli/install.sh | sh

The installer doesn't touch your shell config by default — it only installs the binary. To have a new terminal run yoooclaw directly, pass --modify-path explicitly to write the install directory into your shell config.

Building from source

bash
git clone https://github.com/YoooClaw/cli.git
cd cli

go test ./...
go vet ./...
scripts/build-go.sh --current
dist-native/yoooclaw-darwin-arm64 --help

See CLI: Overview & Installation for more.

OpenClaw plugin quickstart

@yoooclaw/phone-notifications installs into an OpenClaw / QClaw host and handles phone notification ingest and local storage, search/summary/stats, scheduled monitoring, long-recording sync with ASR, and hardware light control.

bash
openclaw plugins install @yoooclaw/phone-notifications
openclaw ntf --help

For QClaw, or any host without a global openclaw command, use the one-command script instead:

bash
curl -fsSL https://artifact.yoooclaw.com/plugin/install.sh | bash

See OpenClaw Plugin: Overview & Installation for more.

Hermes plugin quickstart

yoooclaw-hermes-plugin installs into Hermes Agent, letting the phone app chat with Hermes directly while reusing notification / recording / light-rule capabilities. It bundles the platform-specific yoooclaw executable, so there's no need to install the CLI separately.

bash
curl -fsSL https://artifact.yoooclaw.com/hermes-plugin/install.sh | bash -s -- --api-key "ock_..."

See Hermes Plugin: Overview & Installation for more.

Next steps