@quantumclaw/quantumclaw 2026.3.22

package/docs/tools/btw.md

@@ -0,0 +1,142 @@
+---
+summary: "Ephemeral side questions with /btw"
+read_when:
+  - You want to ask a quick side question about the current session
+  - You are implementing or debugging BTW behavior across clients
+title: "BTW Side Questions"
+---
+
+# BTW Side Questions
+
+`/btw` lets you ask a quick side question about the **current session** without
+turning that question into normal conversation history.
+
+It is modeled after Claude Code's `/btw` behavior, but adapted to QuantumClaw's
+Gateway and multi-channel architecture.
+
+## What it does
+
+When you send:
+
+```text
+/btw what changed?
+```
+
+QuantumClaw:
+
+1. snapshots the current session context,
+2. runs a separate **tool-less** model call,
+3. answers only the side question,
+4. leaves the main run alone,
+5. does **not** write the BTW question or answer to session history,
+6. emits the answer as a **live side result** rather than a normal assistant message.
+
+The important mental model is:
+
+- same session context
+- separate one-shot side query
+- no tool calls
+- no future context pollution
+- no transcript persistence
+
+## What it does not do
+
+`/btw` does **not**:
+
+- create a new durable session,
+- continue the unfinished main task,
+- run tools or agent tool loops,
+- write BTW question/answer data to transcript history,
+- appear in `chat.history`,
+- survive a reload.
+
+It is intentionally **ephemeral**.
+
+## How context works
+
+BTW uses the current session as **background context only**.
+
+If the main run is currently active, QuantumClaw snapshots the current message
+state and includes the in-flight main prompt as background context, while
+explicitly telling the model:
+
+- answer only the side question,
+- do not resume or complete the unfinished main task,
+- do not emit tool calls or pseudo-tool calls.
+
+That keeps BTW isolated from the main run while still making it aware of what
+the session is about.
+
+## Delivery model
+
+BTW is **not** delivered as a normal assistant transcript message.
+
+At the Gateway protocol level:
+
+- normal assistant chat uses the `chat` event
+- BTW uses the `chat.side_result` event
+
+This separation is intentional. If BTW reused the normal `chat` event path,
+clients would treat it like regular conversation history.
+
+Because BTW uses a separate live event and is not replayed from
+`chat.history`, it disappears after reload.
+
+## Surface behavior
+
+### TUI
+
+In TUI, BTW is rendered inline in the current session view, but it remains
+ephemeral:
+
+- visibly distinct from a normal assistant reply
+- dismissible with `Enter` or `Esc`
+- not replayed on reload
+
+### External channels
+
+On channels like Telegram, WhatsApp, and Discord, BTW is delivered as a
+clearly labeled one-off reply because those surfaces do not have a local
+ephemeral overlay concept.
+
+The answer is still treated as a side result, not normal session history.
+
+### Control UI / web
+
+The Gateway emits BTW correctly as `chat.side_result`, and BTW is not included
+in `chat.history`, so the persistence contract is already correct for web.
+
+The current Control UI still needs a dedicated `chat.side_result` consumer to
+render BTW live in the browser. Until that client-side support lands, BTW is a
+Gateway-level feature with full TUI and external-channel behavior, but not yet
+a complete browser UX.
+
+## When to use BTW
+
+Use `/btw` when you want:
+
+- a quick clarification about the current work,
+- a factual side answer while a long run is still in progress,
+- a temporary answer that should not become part of future session context.
+
+Examples:
+
+```text
+/btw what file are we editing?
+/btw what does this error mean?
+/btw summarize the current task in one sentence
+/btw what is 17 * 19?
+```
+
+## When not to use BTW
+
+Do not use `/btw` when you want the answer to become part of the session's
+future working context.
+
+In that case, ask normally in the main session instead of using BTW.
+
+## Related
+
+- [Slash commands](/tools/slash-commands)
+- [Thinking Levels](/tools/thinking)
+- [Session](/concepts/session)

package/docs/tools/capability-cookbook.md

@@ -0,0 +1,119 @@
+---
+summary: "Contributor guide for adding a new shared capability to the QuantumClaw plugin system"
+read_when:
+  - Adding a new core capability and plugin registration surface
+  - Deciding whether code belongs in core, a vendor plugin, or a feature plugin
+  - Wiring a new runtime helper for channels or tools
+title: "Adding Capabilities (Contributor Guide)"
+sidebarTitle: "Adding Capabilities"
+---
+
+# Adding Capabilities
+
+<Info>
+  This is a **contributor guide** for QuantumClaw core developers. If you are
+  building an external plugin, see [Building Plugins](/plugins/building-plugins)
+  instead.
+</Info>
+
+Use this when QuantumClaw needs a new domain such as image generation, video
+generation, or some future vendor-backed feature area.
+
+The rule:
+
+- plugin = ownership boundary
+- capability = shared core contract
+
+That means you should not start by wiring a vendor directly into a channel or a
+tool. Start by defining the capability.
+
+## When to create a capability
+
+Create a new capability when all of these are true:
+
+1. more than one vendor could plausibly implement it
+2. channels, tools, or feature plugins should consume it without caring about
+   the vendor
+3. core needs to own fallback, policy, config, or delivery behavior
+
+If the work is vendor-only and no shared contract exists yet, stop and define
+the contract first.
+
+## The standard sequence
+
+1. Define the typed core contract.
+2. Add plugin registration for that contract.
+3. Add a shared runtime helper.
+4. Wire one real vendor plugin as proof.
+5. Move feature/channel consumers onto the runtime helper.
+6. Add contract tests.
+7. Document the operator-facing config and ownership model.
+
+## What goes where
+
+Core:
+
+- request/response types
+- provider registry + resolution
+- fallback behavior
+- config schema and labels/help
+- runtime helper surface
+
+Vendor plugin:
+
+- vendor API calls
+- vendor auth handling
+- vendor-specific request normalization
+- registration of the capability implementation
+
+Feature/channel plugin:
+
+- calls `api.runtime.*` or the matching `plugin-sdk/*-runtime` helper
+- never calls a vendor implementation directly
+
+## File checklist
+
+For a new capability, expect to touch these areas:
+
+- `src/<capability>/types.ts`
+- `src/<capability>/...registry/runtime.ts`
+- `src/plugins/types.ts`
+- `src/plugins/registry.ts`
+- `src/plugins/captured-registration.ts`
+- `src/plugins/contracts/registry.ts`
+- `src/plugins/runtime/types-core.ts`
+- `src/plugins/runtime/index.ts`
+- `src/plugin-sdk/<capability>.ts`
+- `src/plugin-sdk/<capability>-runtime.ts`
+- one or more `extensions/<vendor>/...`
+- config/docs/tests
+
+## Example: image generation
+
+Image generation follows the standard shape:
+
+1. core defines `ImageGenerationProvider`
+2. core exposes `registerImageGenerationProvider(...)`
+3. core exposes `runtime.imageGeneration.generate(...)`
+4. the `openai` and `google` plugins register vendor-backed implementations
+5. future vendors can register the same contract without changing channels/tools
+
+The config key is separate from vision-analysis routing:
+
+- `agents.defaults.imageModel` = analyze images
+- `agents.defaults.imageGenerationModel` = generate images
+
+Keep those separate so fallback and policy remain explicit.
+
+## Review checklist
+
+Before shipping a new capability, verify:
+
+- no channel/tool imports vendor code directly
+- the runtime helper is the shared path
+- at least one contract test asserts bundled ownership
+- config docs name the new model/config key
+- plugin docs explain the ownership boundary
+
+If a PR skips the capability layer and hardcodes vendor behavior into a
+channel/tool, send it back and define the contract first.

package/docs/tools/clawhub.md

@@ -0,0 +1,298 @@
+---
+summary: "ClawHub guide: public registry, native QuantumClaw install flows, and ClawHub CLI workflows"
+read_when:
+  - Introducing ClawHub to new users
+  - Installing, searching, or publishing skills
+  - Explaining ClawHub CLI flags and sync behavior
+title: "ClawHub"
+---
+
+# ClawHub
+
+ClawHub is the public registry for **QuantumClaw skills and plugins**.
+
+- Use native `quantumclaw` commands to search/install/update skills and install
+  plugins from ClawHub.
+- Use the separate `clawhub` CLI when you need registry auth, publish, delete,
+  undelete, or sync workflows.
+
+Site: [clawhub.ai](https://clawhub.ai)
+
+## Native QuantumClaw flows
+
+Skills:
+
+```bash
+quantumclaw skills search "calendar"
+quantumclaw skills install <skill-slug>
+quantumclaw skills update --all
+```
+
+Plugins:
+
+```bash
+quantumclaw plugins install clawhub:<package>
+quantumclaw plugins update --all
+```
+
+Bare npm-safe plugin specs are also tried against ClawHub before npm:
+
+```bash
+quantumclaw plugins install quantumclaw-codex-app-server
+```
+
+Native `quantumclaw` commands install into your active workspace and persist source
+metadata so later `update` calls can stay on ClawHub.
+
+## What ClawHub is
+
+- A public registry for QuantumClaw skills.
+- A versioned store of skill bundles and metadata.
+- A discovery surface for search, tags, and usage signals.
+
+## How it works
+
+1. A user publishes a skill bundle (files + metadata).
+2. ClawHub stores the bundle, parses metadata, and assigns a version.
+3. The registry indexes the skill for search and discovery.
+4. Users browse, download, and install skills in QuantumClaw.
+
+## What you can do
+
+- Publish new skills and new versions of existing skills.
+- Discover skills by name, tags, or search.
+- Download skill bundles and inspect their files.
+- Report skills that are abusive or unsafe.
+- If you are a moderator, hide, unhide, delete, or ban.
+
+## Who this is for (beginner-friendly)
+
+If you want to add new capabilities to your QuantumClaw agent, ClawHub is the easiest way to find and install skills. You do not need to know how the backend works. You can:
+
+- Search for skills by plain language.
+- Install a skill into your workspace.
+- Update skills later with one command.
+- Back up your own skills by publishing them.
+
+## Quick start (non-technical)
+
+1. Search for something you need:
+   - `quantumclaw skills search "calendar"`
+2. Install a skill:
+   - `quantumclaw skills install <skill-slug>`
+3. Start a new QuantumClaw session so it picks up the new skill.
+4. If you want to publish or manage registry auth, install the separate
+   `clawhub` CLI too.
+
+## Install the ClawHub CLI
+
+You only need this for registry-authenticated workflows such as publish/sync:
+
+```bash
+npm i -g clawhub
+```
+
+```bash
+pnpm add -g clawhub
+```
+
+## How it fits into QuantumClaw
+
+Native `quantumclaw skills install` installs into the active workspace `skills/`
+directory. `quantumclaw plugins install clawhub:...` records a normal managed
+plugin install plus ClawHub source metadata for updates.
+
+The separate `clawhub` CLI also installs skills into `./skills` under your
+current working directory. If an QuantumClaw workspace is configured, `clawhub`
+falls back to that workspace unless you override `--workdir` (or
+`CLAWHUB_WORKDIR`). QuantumClaw loads workspace skills from `<workspace>/skills`
+and will pick them up in the **next** session. If you already use
+`~/.quantumclaw/skills` or bundled skills, workspace skills take precedence.
+
+For more detail on how skills are loaded, shared, and gated, see
+[Skills](/tools/skills).
+
+## Skill system overview
+
+A skill is a versioned bundle of files that teaches QuantumClaw how to perform a
+specific task. Each publish creates a new version, and the registry keeps a
+history of versions so users can audit changes.
+
+A typical skill includes:
+
+- A `SKILL.md` file with the primary description and usage.
+- Optional configs, scripts, or supporting files used by the skill.
+- Metadata such as tags, summary, and install requirements.
+
+ClawHub uses metadata to power discovery and safely expose skill capabilities.
+The registry also tracks usage signals (such as stars and downloads) to improve
+ranking and visibility.
+
+## What the service provides (features)
+
+- **Public browsing** of skills and their `SKILL.md` content.
+- **Search** powered by embeddings (vector search), not just keywords.
+- **Versioning** with semver, changelogs, and tags (including `latest`).
+- **Downloads** as a zip per version.
+- **Stars and comments** for community feedback.
+- **Moderation** hooks for approvals and audits.
+- **CLI-friendly API** for automation and scripting.
+
+## Security and moderation
+
+ClawHub is open by default. Anyone can upload skills, but a GitHub account must
+be at least one week old to publish. This helps slow down abuse without blocking
+legitimate contributors.
+
+Reporting and moderation:
+
+- Any signed in user can report a skill.
+- Report reasons are required and recorded.
+- Each user can have up to 20 active reports at a time.
+- Skills with more than 3 unique reports are auto hidden by default.
+- Moderators can view hidden skills, unhide them, delete them, or ban users.
+- Abusing the report feature can result in account bans.
+
+Interested in becoming a moderator? Ask in the QuantumClaw Discord and contact a
+moderator or maintainer.
+
+## CLI commands and parameters
+
+Global options (apply to all commands):
+
+- `--workdir <dir>`: Working directory (default: current dir; falls back to QuantumClaw workspace).
+- `--dir <dir>`: Skills directory, relative to workdir (default: `skills`).
+- `--site <url>`: Site base URL (browser login).
+- `--registry <url>`: Registry API base URL.
+- `--no-input`: Disable prompts (non-interactive).
+- `-V, --cli-version`: Print CLI version.
+
+Auth:
+
+- `clawhub login` (browser flow) or `clawhub login --token <token>`
+- `clawhub logout`
+- `clawhub whoami`
+
+Options:
+
+- `--token <token>`: Paste an API token.
+- `--label <label>`: Label stored for browser login tokens (default: `CLI token`).
+- `--no-browser`: Do not open a browser (requires `--token`).
+
+Search:
+
+- `clawhub search "query"`
+- `--limit <n>`: Max results.
+
+Install:
+
+- `clawhub install <slug>`
+- `--version <version>`: Install a specific version.
+- `--force`: Overwrite if the folder already exists.
+
+Update:
+
+- `clawhub update <slug>`
+- `clawhub update --all`
+- `--version <version>`: Update to a specific version (single slug only).
+- `--force`: Overwrite when local files do not match any published version.
+
+List:
+
+- `clawhub list` (reads `.clawhub/lock.json`)
+
+Publish:
+
+- `clawhub publish <path>`
+- `--slug <slug>`: Skill slug.
+- `--name <name>`: Display name.
+- `--version <version>`: Semver version.
+- `--changelog <text>`: Changelog text (can be empty).
+- `--tags <tags>`: Comma-separated tags (default: `latest`).
+
+Delete/undelete (owner/admin only):
+
+- `clawhub delete <slug> --yes`
+- `clawhub undelete <slug> --yes`
+
+Sync (scan local skills + publish new/updated):
+
+- `clawhub sync`
+- `--root <dir...>`: Extra scan roots.
+- `--all`: Upload everything without prompts.
+- `--dry-run`: Show what would be uploaded.
+- `--bump <type>`: `patch|minor|major` for updates (default: `patch`).
+- `--changelog <text>`: Changelog for non-interactive updates.
+- `--tags <tags>`: Comma-separated tags (default: `latest`).
+- `--concurrency <n>`: Registry checks (default: 4).
+
+## Common workflows for agents
+
+### Search for skills
+
+```bash
+clawhub search "postgres backups"
+```
+
+### Download new skills
+
+```bash
+clawhub install my-skill-pack
+```
+
+### Update installed skills
+
+```bash
+clawhub update --all
+```
+
+### Back up your skills (publish or sync)
+
+For a single skill folder:
+
+```bash
+clawhub publish ./my-skill --slug my-skill --name "My Skill" --version 1.0.0 --tags latest
+```
+
+To scan and back up many skills at once:
+
+```bash
+clawhub sync --all
+```
+
+## Advanced details (technical)
+
+### Versioning and tags
+
+- Each publish creates a new **semver** `SkillVersion`.
+- Tags (like `latest`) point to a version; moving tags lets you roll back.
+- Changelogs are attached per version and can be empty when syncing or publishing updates.
+
+### Local changes vs registry versions
+
+Updates compare the local skill contents to registry versions using a content hash. If local files do not match any published version, the CLI asks before overwriting (or requires `--force` in non-interactive runs).
+
+### Sync scanning and fallback roots
+
+`clawhub sync` scans your current workdir first. If no skills are found, it falls back to known legacy locations (for example `~/quantumclaw/skills` and `~/.quantumclaw/skills`). This is designed to find older skill installs without extra flags.
+
+### Storage and lockfile
+
+- Installed skills are recorded in `.clawhub/lock.json` under your workdir.
+- Auth tokens are stored in the ClawHub CLI config file (override via `CLAWHUB_CONFIG_PATH`).
+
+### Telemetry (install counts)
+
+When you run `clawhub sync` while logged in, the CLI sends a minimal snapshot to compute install counts. You can disable this entirely:
+
+```bash
+export CLAWHUB_DISABLE_TELEMETRY=1
+```
+
+## Environment variables
+
+- `CLAWHUB_SITE`: Override the site URL.
+- `CLAWHUB_REGISTRY`: Override the registry API URL.
+- `CLAWHUB_CONFIG_PATH`: Override where the CLI stores the token/config.
+- `CLAWHUB_WORKDIR`: Override the default workdir.
+- `CLAWHUB_DISABLE_TELEMETRY=1`: Disable telemetry on `sync`.

package/docs/tools/creating-skills.md

@@ -0,0 +1,117 @@
+---
+title: "Creating Skills"
+summary: "Build and test custom workspace skills with SKILL.md"
+read_when:
+  - You are creating a new custom skill in your workspace
+  - You need a quick starter workflow for SKILL.md-based skills
+---
+
+# Creating Skills
+
+Skills teach the agent how and when to use tools. Each skill is a directory
+containing a `SKILL.md` file with YAML frontmatter and markdown instructions.
+
+For how skills are loaded and prioritized, see [Skills](/tools/skills).
+
+## Create your first skill
+
+<Steps>
+  <Step title="Create the skill directory">
+    Skills live in your workspace. Create a new folder:
+
+    ```bash
+    mkdir -p ~/.quantumclaw/workspace/skills/hello-world
+    ```
+
+  </Step>
+
+  <Step title="Write SKILL.md">
+    Create `SKILL.md` inside that directory. The frontmatter defines metadata,
+    and the markdown body contains instructions for the agent.
+
+    ```markdown
+    ---
+    name: hello_world
+    description: A simple skill that says hello.
+    ---
+
+    # Hello World Skill
+
+    When the user asks for a greeting, use the `echo` tool to say
+    "Hello from your custom skill!".
+    ```
+
+  </Step>
+
+  <Step title="Add tools (optional)">
+    You can define custom tool schemas in the frontmatter or instruct the agent
+    to use existing system tools (like `exec` or `browser`). Skills can also
+    ship inside plugins alongside the tools they document.
+
+  </Step>
+
+  <Step title="Load the skill">
+    Start a new session so QuantumClaw picks up the skill:
+
+    ```bash
+    # From chat
+    /new
+
+    # Or restart the gateway
+    quantumclaw gateway restart
+    ```
+
+    Verify the skill loaded:
+
+    ```bash
+    quantumclaw skills list
+    ```
+
+  </Step>
+
+  <Step title="Test it">
+    Send a message that should trigger the skill:
+
+    ```bash
+    quantumclaw agent --message "give me a greeting"
+    ```
+
+    Or just chat with the agent and ask for a greeting.
+
+  </Step>
+</Steps>
+
+## Skill metadata reference
+
+The YAML frontmatter supports these fields:
+
+| Field                               | Required | Description                                 |
+| ----------------------------------- | -------- | ------------------------------------------- |
+| `name`                              | Yes      | Unique identifier (snake_case)              |
+| `description`                       | Yes      | One-line description shown to the agent     |
+| `metadata.quantumclaw.os`              | No       | OS filter (`["darwin"]`, `["linux"]`, etc.) |
+| `metadata.quantumclaw.requires.bins`   | No       | Required binaries on PATH                   |
+| `metadata.quantumclaw.requires.config` | No       | Required config keys                        |
+
+## Best practices
+
+- **Be concise** — instruct the model on _what_ to do, not how to be an AI
+- **Safety first** — if your skill uses `exec`, ensure prompts don't allow arbitrary command injection from untrusted input
+- **Test locally** — use `quantumclaw agent --message "..."` to test before sharing
+- **Use ClawHub** — browse and contribute skills at [ClawHub](https://clawhub.com)
+
+## Where skills live
+
+| Location                        | Precedence | Scope                 |
+| ------------------------------- | ---------- | --------------------- |
+| `\<workspace\>/skills/`         | Highest    | Per-agent             |
+| `~/.quantumclaw/skills/`           | Medium     | Shared (all agents)   |
+| Bundled (shipped with QuantumClaw) | Lowest     | Global                |
+| `skills.load.extraDirs`         | Lowest     | Custom shared folders |
+
+## Related
+
+- [Skills reference](/tools/skills) — loading, precedence, and gating rules
+- [Skills config](/tools/skills-config) — `skills.*` config schema
+- [ClawHub](/tools/clawhub) — public skill registry
+- [Building Plugins](/plugins/building-plugins) — plugins can ship skills