@symerian/symi 3.0.20 → 3.0.22

package/docs/cli/logs.md

@@ -1,28 +0,0 @@
----
-summary: "CLI reference for `symi logs` (tail gateway logs via RPC)"
-read_when:
-  - You need to tail Gateway logs remotely (without SSH)
-  - You want JSON log lines for tooling
-title: "logs"
----
-
-# `symi logs`
-
-Tail Gateway file logs over RPC (works in remote mode).
-
-Related:
-
-- Logging overview: [Logging](/logging)
-
-## Examples
-
-```bash
-symi logs
-symi logs --follow
-symi logs --json
-symi logs --limit 500
-symi logs --local-time
-symi logs --follow --local-time
-```
-
-Use `--local-time` to render timestamps in your local timezone.

package/docs/cli/memory.md

@@ -1,45 +0,0 @@
----
-summary: "CLI reference for `symi memory` (status/index/search)"
-read_when:
-  - You want to index or search semantic memory
-  - You’re debugging memory availability or indexing
-title: "memory"
----
-
-# `symi memory`
-
-Manage semantic memory indexing and search.
-Provided by the active memory plugin (default: `memory-core`; set `plugins.slots.memory = "none"` to disable).
-
-Related:
-
-- Memory concept: [Memory](/concepts/memory)
-- Plugins: [Plugins](/tools/plugin)
-
-## Examples
-
-```bash
-symi memory status
-symi memory status --deep
-symi memory status --deep --index
-symi memory status --deep --index --verbose
-symi memory index
-symi memory index --verbose
-symi memory search "release checklist"
-symi memory status --agent main
-symi memory index --agent main --verbose
-```
-
-## Options
-
-Common:
-
-- `--agent <id>`: scope to a single agent (default: all configured agents).
-- `--verbose`: emit detailed logs during probes and indexing.
-
-Notes:
-
-- `memory status --deep` probes vector + embedding availability.
-- `memory status --deep --index` runs a reindex if the store is dirty.
-- `memory index --verbose` prints per-phase details (provider, model, sources, batch activity).
-- `memory status` includes any extra paths configured via `memorySearch.extraPaths`.

package/docs/cli/message.md

@@ -1,214 +0,0 @@
----
-summary: "CLI reference for `symi message` (send + channel actions)"
-read_when:
-  - Adding or modifying message CLI actions
-  - Changing outbound channel behavior
-title: "message"
----
-
-# `symi message`
-
-Single outbound command for sending messages and channel actions
-
-## Usage
-
-```
-symi message <subcommand> [flags]
-```
-
-Channel selection:
-
-- `--channel` required if more than one channel is configured.
-- If exactly one channel is configured, it becomes the default.
-
-Target formats (`--target`):
-
-- WhatsApp: E.164 or group JID
-- Telegram: chat id or `@username`
-- Google Chat: `spaces/<spaceId>` or `users/<userId>`
-- Slack: `channel:<id>` or `user:<id>` (raw channel id is accepted)
-- Mattermost (plugin): `channel:<id>`, `user:<id>`, or `@username` (bare ids are treated as channels)
-- Signal: `+E.164`, `group:<id>`, `signal:+E.164`, `signal:group:<id>`, or `username:<name>`/`u:<name>`
-- iMessage: handle, `chat_id:<id>`, `chat_guid:<guid>`, or `chat_identifier:<id>`
-- MS Teams: conversation id (`19:...@thread.tacv2`) or `conversation:<id>` or `user:<aad-object-id>`
-
-Name lookup:
-
-- On cache miss, Symi will attempt a live directory lookup when the provider supports it.
-
-## Common flags
-
-- `--channel <name>`
-- `--account <id>`
-- `--target <dest>` (target channel or user for send/poll/read/etc)
-- `--targets <name>` (repeat; broadcast only)
-- `--json`
-- `--dry-run`
-- `--verbose`
-
-## Actions
-
-### Core
-
-- `send`
-  - Required: `--target`, plus `--message` or `--media`
-  - Optional: `--media`, `--reply-to`, `--thread-id`, `--gif-playback`
-  - Telegram only: `--buttons` (requires `channels.telegram.capabilities.inlineButtons` to allow it)
-  - Telegram only: `--thread-id` (forum topic id)
-  - Slack only: `--thread-id` (thread timestamp; `--reply-to` uses the same field)
-  - WhatsApp only: `--gif-playback`
-
-- `poll`
-  - Required: `--target`, `--poll-question`, `--poll-option` (repeat)
-  - Optional: `--poll-multi`
-  - Telegram only: `--poll-duration-seconds` (5-600), `--silent`, `--poll-anonymous` / `--poll-public`, `--thread-id`
-
-- `react`
-  - Required: `--message-id`, `--target`
-  - Optional: `--emoji`, `--remove`, `--participant`, `--from-me`, `--target-author`, `--target-author-uuid`
-  - Note: `--remove` requires `--emoji` (omit `--emoji` to clear own reactions where supported; see /tools/reactions)
-  - WhatsApp only: `--participant`, `--from-me`
-  - Signal group reactions: `--target-author` or `--target-author-uuid` required
-
-- `reactions`
-  - Required: `--message-id`, `--target`
-  - Optional: `--limit`
-
-- `read`
-  - Required: `--target`
-  - Optional: `--limit`, `--before`, `--after`
-
-- `edit`
-  - Required: `--message-id`, `--message`, `--target`
-
-- `delete`
-  - Required: `--message-id`, `--target`
-
-- `pin` / `unpin`
-  - Required: `--message-id`, `--target`
-
-- `pins` (list)
-  - Required: `--target`
-
-- `permissions`
-  - Required: `--target`
-
-- `search`
-  - Required: `--guild-id`, `--query`
-  - Optional: `--channel-id`, `--channel-ids` (repeat), `--author-id`, `--author-ids` (repeat), `--limit`
-
-### Threads
-
-- `thread create`
-  - Required: `--thread-name`, `--target` (channel id)
-  - Optional: `--message-id`, `--message`, `--auto-archive-min`
-
-- `thread list`
-  - Required: `--guild-id`
-  - Optional: `--channel-id`, `--include-archived`, `--before`, `--limit`
-
-- `thread reply`
-  - Required: `--target` (thread id), `--message`
-  - Optional: `--media`, `--reply-to`
-
-### Emojis
-
-- `emoji list`
-  - Slack: no extra flags
-
-- `emoji upload`
-  - Required: `--guild-id`, `--emoji-name`, `--media`
-  - Optional: `--role-ids` (repeat)
-
-### Stickers
-
-- `sticker send`
-  - Required: `--target`, `--sticker-id` (repeat)
-  - Optional: `--message`
-
-- `sticker upload`
-  - Required: `--guild-id`, `--sticker-name`, `--sticker-desc`, `--sticker-tags`, `--media`
-
-### Roles / Channels / Members / Voice
-
-### Events
-
-- Optional: `--end-time`, `--desc`, `--channel-id`, `--location`, `--event-type`
-
-- `timeout`: `--guild-id`, `--user-id` (optional `--duration-min` or `--until`; omit both to clear timeout)
-- `kick`: `--guild-id`, `--user-id` (+ `--reason`)
-- `ban`: `--guild-id`, `--user-id` (+ `--delete-days`, `--reason`)
-  - `timeout` also supports `--reason`
-
-### Broadcast
-
-- `broadcast`
-  - Channels: any configured channel; use `--channel all` to target all providers
-  - Required: `--targets` (repeat)
-  - Optional: `--message`, `--media`, `--dry-run`
-
-## Examples
-
-```
-  --target channel:123 --message "hi" --reply-to 456
-```
-
-```
-  --target channel:123 --message "Choose:" \
-  --components '{"text":"Choose a path","blocks":[{"type":"actions","buttons":[{"label":"Approve","style":"success"},{"label":"Decline","style":"danger"}]}]}'
-```
-
-```
-  --target channel:123 \
-  --poll-question "Snack?" \
-  --poll-option Pizza --poll-option Sushi \
-  --poll-multi --poll-duration-hours 48
-```
-
-Create a Telegram poll (auto-close in 2 minutes):
-
-```
-symi message poll --channel telegram \
-  --target @mychat \
-  --poll-question "Lunch?" \
-  --poll-option Pizza --poll-option Sushi \
-  --poll-duration-seconds 120 --silent
-```
-
-Send a Teams proactive message:
-
-```
-symi message send --channel msteams \
-  --target conversation:19:abc@thread.tacv2 --message "hi"
-```
-
-Create a Teams poll:
-
-```
-symi message poll --channel msteams \
-  --target conversation:19:abc@thread.tacv2 \
-  --poll-question "Lunch?" \
-  --poll-option Pizza --poll-option Sushi
-```
-
-React in Slack:
-
-```
-symi message react --channel slack \
-  --target C123 --message-id 456 --emoji "✅"
-```
-
-React in a Signal group:
-
-```
-symi message react --channel signal \
-  --target signal:group:abc123 --message-id 1737630212345 \
-  --emoji "✅" --target-author-uuid 123e4567-e89b-12d3-a456-426614174000
-```
-
-Send Telegram inline buttons:
-
-```
-symi message send --channel telegram --target @mychat --message "Choose:" \
-  --buttons '[ [{"text":"Yes","callback_data":"cmd:yes"}], [{"text":"No","callback_data":"cmd:no"}] ]'
-```

package/docs/cli/models.md

@@ -1,79 +0,0 @@
----
-summary: "CLI reference for `symi models` (status/list/set/scan, aliases, fallbacks, auth)"
-read_when:
-  - You want to change default models or view provider auth status
-  - You want to scan available models/providers and debug auth profiles
-title: "models"
----
-
-# `symi models`
-
-Model discovery, scanning, and configuration (default model, fallbacks, auth profiles).
-
-Related:
-
-- Providers + models: [Models](/providers/models)
-- Provider auth setup: [Getting started](/start/getting-started)
-
-## Common commands
-
-```bash
-symi models status
-symi models list
-symi models set <model-or-alias>
-symi models scan
-```
-
-`symi models status` shows the resolved default/fallbacks plus an auth overview.
-When provider usage snapshots are available, the OAuth/token status section includes
-provider usage headers.
-Add `--probe` to run live auth probes against each configured provider profile.
-Probes are real requests (may consume tokens and trigger rate limits).
-Use `--agent <id>` to inspect a configured agent’s model/auth state. When omitted,
-the command uses `SYMI_AGENT_DIR`/`PI_CODING_AGENT_DIR` if set, otherwise the
-configured default agent.
-
-Notes:
-
-- `models set <model-or-alias>` accepts `provider/model` or an alias.
-- Model refs are parsed by splitting on the **first** `/`. If the model ID includes `/` (OpenRouter-style), include the provider prefix (example: `openrouter/moonshotai/kimi-k2`).
-- If you omit the provider, Symi treats the input as an alias or a model for the **default provider** (only works when there is no `/` in the model ID).
-
-### `models status`
-
-Options:
-
-- `--json`
-- `--plain`
-- `--check` (exit 1=expired/missing, 2=expiring)
-- `--probe` (live probe of configured auth profiles)
-- `--probe-provider <name>` (probe one provider)
-- `--probe-profile <id>` (repeat or comma-separated profile ids)
-- `--probe-timeout <ms>`
-- `--probe-concurrency <n>`
-- `--probe-max-tokens <n>`
-- `--agent <id>` (configured agent id; overrides `SYMI_AGENT_DIR`/`PI_CODING_AGENT_DIR`)
-
-## Aliases + fallbacks
-
-```bash
-symi models aliases list
-symi models fallbacks list
-```
-
-## Auth profiles
-
-```bash
-symi models auth add
-symi models auth login --provider <id>
-symi models auth setup-token
-symi models auth paste-token
-```
-
-`models auth login` runs a provider plugin’s auth flow (OAuth/API key). Use
-`symi plugins list` to see which providers are installed.
-
-Notes:
-
-- `setup-token` prompts for a setup-token value (generate it with `claude setup-token` on any machine).
-- `paste-token` accepts a token string generated elsewhere or from automation.

package/docs/cli/node.md

@@ -1,112 +0,0 @@
----
-summary: "CLI reference for `symi node` (headless node host)"
-read_when:
-  - Running the headless node host
-  - Pairing a non-macOS node for system.run
-title: "node"
----
-
-# `symi node`
-
-Run a **headless node host** that connects to the Gateway WebSocket and exposes
-`system.run` / `system.which` on this machine.
-
-## Why use a node host?
-
-Use a node host when you want agents to **run commands on other machines** in your
-network without installing a full macOS companion app there.
-
-Common use cases:
-
-- Run commands on remote Linux/Windows boxes (build servers, lab machines, NAS).
-- Keep exec **sandboxed** on the gateway, but delegate approved runs to other hosts.
-- Provide a lightweight, headless execution target for automation or CI nodes.
-
-Execution is still guarded by **exec approvals** and per‑agent allowlists on the
-node host, so you can keep command access scoped and explicit.
-
-## Browser proxy (zero-config)
-
-Node hosts automatically advertise a browser proxy if `browser.enabled` is not
-disabled on the node. This lets the agent use browser automation on that node
-without extra configuration.
-
-Disable it on the node if needed:
-
-```json5
-{
-  nodeHost: {
-    browserProxy: {
-      enabled: false,
-    },
-  },
-}
-```
-
-## Run (foreground)
-
-```bash
-symi node run --host <gateway-host> --port 18789
-```
-
-Options:
-
-- `--host <host>`: Gateway WebSocket host (default: `127.0.0.1`)
-- `--port <port>`: Gateway WebSocket port (default: `18789`)
-- `--tls`: Use TLS for the gateway connection
-- `--tls-fingerprint <sha256>`: Expected TLS certificate fingerprint (sha256)
-- `--node-id <id>`: Override node id (clears pairing token)
-- `--display-name <name>`: Override the node display name
-
-## Service (background)
-
-Install a headless node host as a user service.
-
-```bash
-symi node install --host <gateway-host> --port 18789
-```
-
-Options:
-
-- `--host <host>`: Gateway WebSocket host (default: `127.0.0.1`)
-- `--port <port>`: Gateway WebSocket port (default: `18789`)
-- `--tls`: Use TLS for the gateway connection
-- `--tls-fingerprint <sha256>`: Expected TLS certificate fingerprint (sha256)
-- `--node-id <id>`: Override node id (clears pairing token)
-- `--display-name <name>`: Override the node display name
-- `--runtime <runtime>`: Service runtime (`node` or `bun`)
-- `--force`: Reinstall/overwrite if already installed
-
-Manage the service:
-
-```bash
-symi node status
-symi node stop
-symi node restart
-symi node uninstall
-```
-
-Use `symi node run` for a foreground node host (no service).
-
-Service commands accept `--json` for machine-readable output.
-
-## Pairing
-
-The first connection creates a pending node pair request on the Gateway.
-Approve it via:
-
-```bash
-symi nodes pending
-symi nodes approve <requestId>
-```
-
-The node host stores its node id, token, display name, and gateway connection info in
-`~/.symi/node.json`.
-
-## Exec approvals
-
-`system.run` is gated by local exec approvals:
-
-- `~/.symi/exec-approvals.json`
-- [Exec approvals](/tools/exec-approvals)
-- `symi approvals --node <id|name|ip>` (edit from the Gateway)

package/docs/cli/nodes.md

@@ -1,73 +0,0 @@
----
-summary: "CLI reference for `symi nodes` (list/status/approve/invoke, camera/canvas/screen)"
-read_when:
-  - You’re managing paired nodes (cameras, screen, canvas)
-  - You need to approve requests or invoke node commands
-title: "nodes"
----
-
-# `symi nodes`
-
-Manage paired nodes (devices) and invoke node capabilities.
-
-Related:
-
-- Nodes overview: [Nodes](/nodes)
-- Camera: [Camera nodes](/nodes/camera)
-- Images: [Image nodes](/nodes/images)
-
-Common options:
-
-- `--url`, `--token`, `--timeout`, `--json`
-
-## Common commands
-
-```bash
-symi nodes list
-symi nodes list --connected
-symi nodes list --last-connected 24h
-symi nodes pending
-symi nodes approve <requestId>
-symi nodes status
-symi nodes status --connected
-symi nodes status --last-connected 24h
-```
-
-`nodes list` prints pending/paired tables. Paired rows include the most recent connect age (Last Connect).
-Use `--connected` to only show currently-connected nodes. Use `--last-connected <duration>` to
-filter to nodes that connected within a duration (e.g. `24h`, `7d`).
-
-## Invoke / run
-
-```bash
-symi nodes invoke --node <id|name|ip> --command <command> --params <json>
-symi nodes run --node <id|name|ip> <command...>
-symi nodes run --raw "git status"
-symi nodes run --agent main --node <id|name|ip> --raw "git status"
-```
-
-Invoke flags:
-
-- `--params <json>`: JSON object string (default `{}`).
-- `--invoke-timeout <ms>`: node invoke timeout (default `15000`).
-- `--idempotency-key <key>`: optional idempotency key.
-
-### Exec-style defaults
-
-`nodes run` mirrors the model’s exec behavior (defaults + approvals):
-
-- Reads `tools.exec.*` (plus `agents.list[].tools.exec.*` overrides).
-- Uses exec approvals (`exec.approval.request`) before invoking `system.run`.
-- `--node` can be omitted when `tools.exec.node` is set.
-- Requires a node that advertises `system.run` (macOS companion app or headless node host).
-
-Flags:
-
-- `--cwd <path>`: working directory.
-- `--env <key=val>`: env override (repeatable). Note: node hosts ignore `PATH` overrides (and `tools.exec.pathPrepend` is not applied to node hosts).
-- `--command-timeout <ms>`: command timeout.
-- `--invoke-timeout <ms>`: node invoke timeout (default `30000`).
-- `--needs-screen-recording`: require screen recording permission.
-- `--raw <command>`: run a shell string (`/bin/sh -lc` or `cmd.exe /c`).
-- `--agent <id>`: agent-scoped approvals/allowlists (defaults to configured agent).
-- `--ask <off|on-miss|always>`, `--security <deny|allowlist|full>`: overrides.

package/docs/cli/onboard.md

@@ -1,76 +0,0 @@
----
-summary: "CLI reference for `symi onboard` (interactive onboarding wizard)"
-read_when:
-  - You want guided setup for gateway, workspace, auth, channels, and skills
-title: "onboard"
----
-
-# `symi onboard`
-
-Interactive onboarding wizard (local or remote Gateway setup).
-
-## Related guides
-
-- CLI onboarding hub: [Onboarding Wizard (CLI)](/start/wizard)
-- Onboarding overview: [Onboarding Overview](/start/onboarding-overview)
-- CLI onboarding reference: [CLI Onboarding Reference](/start/wizard-cli-reference)
-- CLI automation: [CLI Automation](/start/wizard-cli-automation)
-- macOS onboarding: [Onboarding (macOS App)](/start/onboarding)
-
-## Examples
-
-```bash
-symi onboard
-symi onboard --flow quickstart
-symi onboard --flow manual
-symi onboard --mode remote --remote-url ws://gateway-host:18789
-```
-
-Non-interactive custom provider:
-
-```bash
-symi onboard --non-interactive \
-  --auth-choice custom-api-key \
-  --custom-base-url "https://llm.example.com/v1" \
-  --custom-model-id "foo-large" \
-  --custom-api-key "$CUSTOM_API_KEY" \
-  --custom-compatibility openai
-```
-
-`--custom-api-key` is optional in non-interactive mode. If omitted, onboarding checks `CUSTOM_API_KEY`.
-
-Non-interactive Z.AI endpoint choices:
-
-Note: `--auth-choice zai-api-key` now auto-detects the best Z.AI endpoint for your key (prefers the general API with `zai/glm-5`).
-If you specifically want the GLM Coding Plan endpoints, pick `zai-coding-global` or `zai-coding-cn`.
-
-```bash
-# Promptless endpoint selection
-symi onboard --non-interactive \
-  --auth-choice zai-coding-global \
-  --zai-api-key "$ZAI_API_KEY"
-
-# Other Z.AI endpoint choices:
-# --auth-choice zai-coding-cn
-# --auth-choice zai-global
-# --auth-choice zai-cn
-```
-
-Flow notes:
-
-- `quickstart`: minimal prompts, auto-generates a gateway token.
-- `manual`: full prompts for port/bind/auth (alias of `advanced`).
-- Fastest first chat: `symi dashboard` (Control UI, no channel setup).
-- Custom Provider: connect any OpenAI or Anthropic compatible endpoint,
-  including hosted providers not listed. Use Unknown to auto-detect.
-
-## Common follow-up commands
-
-```bash
-symi configure
-symi agents add <name>
-```
-
-<Note>
-`--json` does not imply non-interactive mode. Use `--non-interactive` for scripts.
-</Note>

package/docs/cli/pairing.md

@@ -1,21 +0,0 @@
----
-summary: "CLI reference for `symi pairing` (approve/list pairing requests)"
-read_when:
-  - You’re using pairing-mode DMs and need to approve senders
-title: "pairing"
----
-
-# `symi pairing`
-
-Approve or inspect DM pairing requests (for channels that support pairing).
-
-Related:
-
-- Pairing flow: [Pairing](/channels/pairing)
-
-## Commands
-
-```bash
-symi pairing list whatsapp
-symi pairing approve whatsapp <code> --notify
-```