YoooClaw CLI

https://github.com/yoooclaw/cli
Admin
YoooClaw CLI is a standalone, agent-native CLI and background daemon that locally receives phone...
Tokens:8,438
Snippets:116
Trust Score:5.6
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install CLI and External Skills

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Install the prerequisite CLI and add skills for specific AI agents.

```bash
# 1. Install the CLI (prerequisite)
npm install -g @yoooclaw/cli

# 2. Install the yoooclaw-cli Skill — Codex + Claude Code
npx skills@latest add YoooClaw/skills --skill yoooclaw-cli --global --agent codex --agent claude-code --copy --yes

# Install for just one agent: pass a single --agent
npx skills@latest add YoooClaw/skills --skill yoooclaw-cli --global --agent claude-code --copy --yes
```

--------------------------------

### Quickstart for AI Agents

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Automated initialization and command execution for AI agents.

```bash
# 1. Initialize via stdin config injection (no interactive prompts), which also starts the daemon
yoooclaw config init --non-interactive --from-file -

# 2. Confirm the daemon is running and the tunnel is connected
yoooclaw daemon status
yoooclaw tunnel status

# 3. Stream notification queries (always based on the latest disk data — don't rely on memory)
yoooclaw notification summary --app WeChat --from 2026-06-01T00:00:00+08:00 --format json

# 4. Install the bundled Skill into the current agent's discovery directory
yoooclaw skills install
```

--------------------------------

### Install via npm

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Use npx for ephemeral execution or install globally to access the yoooclaw and yc commands.

```bash
# No install needed (always pulls the latest version)
npx @yoooclaw/cli --help

# Global install (provides both the yoooclaw and yc commands)
npm i -g @yoooclaw/cli
yoooclaw --help
yc --help
```

--------------------------------

### Install via Native Binary

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Download and install the Go binary directly using the provided shell script.

```bash
# Auto-detect platform, download, verify sha256, install to ~/.local/bin
curl -fsSL https://raw.githubusercontent.com/YoooClaw/cli/master/scripts/install.sh | sh

# Opt in if you want the installer to add its bin directory to your shell PATH
curl -fsSL https://raw.githubusercontent.com/YoooClaw/cli/master/scripts/install.sh \
  | sh -s -- --modify-path

# Pin a version / install directory / force overwrite
curl -fsSL https://raw.githubusercontent.com/YoooClaw/cli/master/scripts/install.sh \
  | sh -s -- --version 0.2.0-beta.2 --dir ~/bin --force
```

--------------------------------

### Quickstart for Human Users

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Initialize the configuration, verify environment readiness, and perform basic queries.

```bash
# 1. Interactive first-run wizard: generates config + gateway token and starts the daemon
yoooclaw config init

# 2. Check auth and environment readiness
yoooclaw auth status
yoooclaw doctor

# 3. Start using it: notification queries read straight from disk, no daemon required
yoooclaw notification +today
```

--------------------------------

### Install Hermes Agent Skill

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Install a skill specifically for the Hermes agent.

```bash
hermes skills install https://raw.githubusercontent.com/YoooClaw/skills/main/yoooclaw-cli/SKILL.md
```

--------------------------------

### Manage Built-in Skills

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Commands to list, view, and install skills bundled within the YoooClaw CLI binary.

```bash
yoooclaw skills list                 # List Skills bundled with this package
yoooclaw skills targets              # View supported agent targets and detection results
yoooclaw skills install              # Auto-detect the sole agent and copy-install
yoooclaw skills install --agent claude
yoooclaw skills install --force      # Refresh bundled Skills and remove merged legacy names
```

--------------------------------

### Daemon status JSON output

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Example of the JSON structure returned by the daemon status command.

```json
{
  "ok": true,
  "version": "0.3.0",
  "executable": "/Users/me/.yoooclaw/hermes-plugin/bin/0.3.0/yoooclaw",
  "profile": "test",
  "lifecycle": {
    "owner": "hermes-plugin",
    "generation": "abc123",
    "startedAt": "2026-06-18T10:34:07Z"
  }
}
```

--------------------------------

### Execute CLI Shortcuts

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Use the '+' prefix for quick operations with smart defaults and table output.

```bash
yoooclaw notification +today          # Today's notification summary
yoooclaw notification +recent         # Notifications from the last hour
yoooclaw recording +latest            # Details of the most recent recording
yoooclaw recording +today             # Recordings from today's local calendar day
yoooclaw light +blink                 # Light-effect connectivity test (red-strobe-3)
yoooclaw lightrule +on                # Enable all light-effect rules
yoooclaw tunnel +test                 # Daemon local ingest + auth self-check
yoooclaw log +errors                  # Error-level logs since yesterday
```

--------------------------------

### Run notification summary for N > 700

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-context-query/references/notifications.md

Use these commands for larger datasets requiring job-based processing. The create command initializes the job, and the run command executes it.

```bash
yoooclaw notification summary-job create --limit N --chunk-size 150 --max-content 120 --format json
# Add --from <ISO_TIME> to create when required.
yoooclaw notification summary-job run <id> --max-chunks 30 --include-result --format json
```

--------------------------------

### Manage yoooclaw authentication credentials

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Demonstrates setting an API key via stdin, managing multiple keys by label, and rotating the gateway token.

```bash
# Write the default api-key securely from stdin, stored in the OS keychain
echo "ock-xxxx" | yoooclaw auth set-api-key - --keychain

# Multi-device/multi-client: manage multiple api-keys by label
yoooclaw auth add-api-key - --label phone-a --default
yoooclaw auth list-api-keys

# Rotate the gateway token, then restart the daemon so it takes effect
yoooclaw auth token-rotate
yoooclaw daemon restart
```

--------------------------------

### Manage CLI Profiles

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Switch between different accounts or devices using the profile commands.

```bash
yoooclaw profile list
yoooclaw profile create work
yoooclaw --profile work notification +today
```

--------------------------------

### Run Development and Build Commands

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Use these commands to verify code integrity, perform static analysis, build the project, and verify the CLI binary.

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

--------------------------------

### Run notification summary for N ≤ 700

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-context-query/references/notifications.md

Use these commands for smaller notification summaries. The second variant allows specifying a time bound.

```bash
yoooclaw notification summary --limit N --sample 12 --top 8 --format json
# With a lower bound:
yoooclaw notification summary --from <ISO_TIME> --limit N --sample 12 --top 8 --format json
```

--------------------------------

### CLI commands for web page management

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-context-query/references/web-pages.md

Standard commands for interacting with the synced-web-page collection. All commands output in JSON format.

```bash
yoooclaw synced-web-page storage-path --format json
yoooclaw synced-web-page list [--from <ISO_TIME>] [--to <ISO_TIME>] --format json
yoooclaw synced-web-page search "<keyword>" --limit <requested-count-or-total-pages> --format json
yoooclaw synced-web-page path <urlHash> --format json
```

--------------------------------

### Manage daemon lifecycle

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Commands to run, stop, and check the status of the yoooclaw daemon with lifecycle metadata.

```bash
yoooclaw daemon run-foreground --owner hermes-plugin --generation abc123
yoooclaw daemon stop --owner hermes-plugin --generation abc123 --wait
yoooclaw daemon status --format json
```

--------------------------------

### Image query CLI commands

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-context-query/references/images.md

Standard commands for interacting with image storage and metadata via the CLI.

```bash
yoooclaw image storage-path --format json
yoooclaw image list --format json
yoooclaw image status <id> --format json
yoooclaw image path <id> --format json
yoooclaw image path <id> --thumbnail --format json
```

--------------------------------

### Locate and list recordings

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-context-query/references/recordings.md

Commands to retrieve storage paths and lists of recordings with optional filtering.

```bash
yoooclaw recording storage-path --format json
yoooclaw recording list --format json
# Optional filters:
yoooclaw recording list --status transcribed --client <label> \
  [--from <ISO_TIME_OR_DATE>] [--to <ISO_TIME_OR_DATE>] --format json
yoooclaw recording +today --format json
```

--------------------------------

### Execute Service Commands

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Structured access to domain capabilities using service and subcommand syntax.

```bash
yoooclaw notification search --app WeChat --keyword meeting --limit 50
yoooclaw notification stats --dim app --from 2026-05-26
yoooclaw notification summary-job create --from 2026-06-01T00:00:00+08:00 --chunk-size 150  # Chunked summarization for large notification batches: create→next→commit→result
yoooclaw recording list --status synced [--from <ISO_TIME_OR_DATE>] [--to <ISO_TIME_OR_DATE>]
yoooclaw recording setup-asr --mode api --language auto --non-interactive
yoooclaw recording setup-asr --mode api --language zh-TW --non-interactive   # Traditional Chinese / Taiwan hint
yoooclaw recording setup-asr --mode api --language zh-Hant --non-interactive # Traditional Chinese script hint
yoooclaw synced-web-page list [--from <ISO_TIME>] [--to <ISO_TIME>]
yoooclaw synced-web-page search "JavaScript" --limit 20
yoooclaw synced-web-page path <url-hash>
yoooclaw synced-web-page storage-path
yoooclaw lightrule create --intent "Flash red when my boss messages me on WeChat"  # Compiled & stored by the cloud service
yoooclaw monitor create daily-standup --schedule "0 9 * * 1-5" --match-rules '{"keyword":"standup"}'
```

--------------------------------

### Configure CLI Output Formats

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Specify the output format for CLI commands using the --format flag.

```bash
--format json      # Full JSON (default when piped)
--format pretty    # Human-friendly formatted output (default on a TTY)
--format table     # Readable table
--format ndjson    # Newline-delimited JSON, convenient for line-by-line piping
```

--------------------------------

### Configure proxied ingress mode

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Command to run the daemon in proxied mode, disabling the internal tunnel and enabling host callback events.

```bash
# Embedded in a host: turn off the Go daemon's own tunnel, let the host proxy the connection and receive callback events
yoooclaw daemon run-foreground --ingress proxied \
  --egress-callback-url http://127.0.0.1:8765/yoooclaw/egress \
  --egress-callback-token <token>
```

--------------------------------

### Diagnose recording status and events

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-context-query/references/recordings.md

Commands to retrieve event logs for recordings to diagnose progress or failures.

```bash
yoooclaw recording events --id <recording_id> --format json
yoooclaw recording events --since 24h --limit 500 --format json
```

--------------------------------

### Interview Markdown Template

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-recordings-process/references/interview.md

Standardized structure for organizing interview notes, including metadata, key points, and topic flow.

```markdown
# <interview-notes heading>: [topic]

> **<overview label>**
> - **<source label>**: `filename.md`
> - **<time label>**: [...]
> - **<interviewee label>**: [...]
> - **<interviewer label>**: [...]
> - **<core-theme label>**: [...]

## <key-points heading>
- ...

## <notable-quotes heading>
- ...

## <topic-flow heading>
1. ...

## <Q&A heading>
**Q1:** ...
**A1:** ...

## <additional-observations heading>
- ...
```

--------------------------------

### Execute Raw API Requests

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Directly reach daemon HTTP endpoints for operations not covered by service commands.

```bash
yoooclaw api GET /daemon/status
yoooclaw api POST /images --data @image.json
echo '{"...":"..."}' | yoooclaw api POST /recordings --data -
```

--------------------------------

### Query Recording Events

Source: https://github.com/yoooclaw/cli/blob/master/README.md

Retrieve recording events using time-based filters or specific recording IDs.

```bash
yoooclaw recording events --since 1h --limit 50
yoooclaw recording events --id <recording-id> --watch
```

--------------------------------

### Resolve recording files

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-context-query/references/recordings.md

Command to check the status of a specific recording by its ID.

```bash
yoooclaw recording status <recording_id> --format json
```

--------------------------------

### yoooclaw synced-web-page storage-path

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-context-query/references/web-pages.md

Retrieves the storage path for the synced web pages.

```APIDOC
## CLI Command: yoooclaw synced-web-page storage-path

### Description
Returns the local storage path for the synced web pages in JSON format.

### Usage
`yoooclaw synced-web-page storage-path --format json`
```

--------------------------------

### Query notification storage path

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-context-query/references/notifications.md

Retrieve the current storage path for notifications in JSON format.

```bash
yoooclaw notification storage-path --format json
```

--------------------------------

### Run notification statistics aggregate commands

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-context-query/references/notification-statistics.md

Executes aggregate queries for notification data using specified dimensions and date ranges. Use the --format json flag to ensure machine-readable output.

```bash
yoooclaw notification stats --dim all --from <DATE_OR_ISO> --to <DATE_OR_ISO> --format json
yoooclaw notification stats --dim sender --sender "<sender>" --from <ISO_TIME> --to <ISO_TIME> --format json
```

--------------------------------

### Execute focused notification searches

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-context-query/references/notifications.md

Perform targeted searches using various filters like time, app, sender, or keywords.

```bash
yoooclaw notification search --limit 20 --format json
yoooclaw notification search --from <ISO_TIME> --to <ISO_TIME> --format json
yoooclaw notification search --app "<app>" --format json
yoooclaw notification search --sender "<sender>" --limit 20 --format json
yoooclaw notification search --keyword "<keyword>" --format json
yoooclaw notification +today --format json
yoooclaw notification +recent --format json
```

--------------------------------

### Meeting Minutes Markdown Template

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-recordings-process/references/meeting-minutes.md

Use this structure to format meeting minutes, ensuring all labels and headers are localized using the replyLanguage.

```markdown
# <meeting-minutes heading>: [topic / filename]

> **<overview label>**
> - **<source label>**: `filename.md`
> - **<time label>**: [source-backed time]
> - **<participants label>**: [identifiable roles]

## <topics-and-decisions heading>
- ...

## <action-items heading>
| <item> | <owner> | <due date> | <status> |
|---|---|---|---|

## <risks-and-open-items heading>
- ...
```

--------------------------------

### yoooclaw synced-web-page list

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-context-query/references/web-pages.md

Lists captured web pages with optional time-based filtering.

```APIDOC
## CLI Command: yoooclaw synced-web-page list

### Description
Lists captured web pages, returning the newest capture first. Supports optional ISO 8601 time boundaries.

### Parameters
- **--from** (ISO_TIME) - Optional - Inclusive start boundary for capture time.
- **--to** (ISO_TIME) - Optional - Exclusive end boundary for capture time.
- **--format** (string) - Required - Must be set to 'json'.

### Response
Returns a list of objects containing: urlHash, title, siteName, canonicalUrl, capturedAt, firstCapturedAt, captureCount, relativePath, and hasArchive.
```

--------------------------------

### yoooclaw synced-web-page path

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-context-query/references/web-pages.md

Retrieves the path for a specific captured page by its hash.

```APIDOC
## CLI Command: yoooclaw synced-web-page path

### Description
Retrieves the path for a specific captured page using its unique URL hash.

### Parameters
- **urlHash** (string) - Required - The unique identifier for the captured page.
- **--format** (string) - Required - Must be set to 'json'.
```

--------------------------------

### CLI Error Response Structure

Source: https://github.com/yoooclaw/cli/blob/master/README.md

The CLI returns a JSON object on failure, including an error code, message, and hint.

```json
{
  "ok": false,
  "error": {
    "code": "YOOOCLAW_DAEMON_NOT_RUNNING",
    "message": "...",
    "hint": "..."
  }
}
```

--------------------------------

### Notification command error response

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-context-query/references/notifications.md

The standard JSON structure returned when a CLI command fails.

```json
{"ok":false,"error":{"code":"YOOOCLAW_...","message":"...","hint":"..."}}
```

--------------------------------

### yoooclaw synced-web-page search

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-context-query/references/web-pages.md

Searches through captured web page metadata and content.

```APIDOC
## CLI Command: yoooclaw synced-web-page search

### Description
Searches title, site name, URL, canonical URL, and Markdown body of captured pages.

### Parameters
- **keyword** (string) - Required - The substantive topic phrase to search for.
- **--limit** (integer) - Optional - The requested count of matches to return.
- **--format** (string) - Required - Must be set to 'json'.
```

--------------------------------

### Markdown Mind Map Structure

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-recordings-process/references/mind-map.md

Standard template for representing hierarchical mind map data in Markdown format.

```md
# <central topic>
- <branch A>
  - <subtopic A1>
    - <key point>
- <branch B>
```

--------------------------------

### Entity Extraction JSON Schema

Source: https://github.com/yoooclaw/cli/blob/master/skills/yoooclaw-recordings-process/references/entity-extraction.md

The required structure for JSON output files generated during the entity extraction process.

```json
{
  "source_file": "...",
  "extracted_at": "...",
  "user_request": "...",
  "entity_types_extracted": [],
  "entities": []
}
```
Tokens:
Raw