diff --git a/README.md b/README.md index 12a8399..c82cf40 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,42 @@ +

+ Terraphim Skills logo +

+ # Terraphim Skills Introduction -Four small, open-source skills connect Terraphim's editor alternatives, local -search, operational learning, and agent memory workflows to Cursor, Kimi Code, AutoClaw, ZCode, -Hermes Agent, skills.sh, Claude Code, and Grok Build. +**Bring local search, editor synonyms, explicit learning, and authored memory +into your agent workflow.** This repository packages four Apache-2.0 +instruction skills and documents direct or custom routes for Cursor, Kimi Code, +AutoClaw, ZCode, Hermes Agent, skills.sh, and Claude Code. A Grok Build +marketplace submission is under review. + +[v0.2.7 release details](docs/distribution.md) +· [Choose an agent](#install-in-your-agent) +· [Try the CLI workflow](docs/cli-workflows.md) +· [Review permissions](docs/permissions.md) +· [简体中文](README_CN.md) + +## Start here + +1. **Install the separate commands** with the [dependency guide](docs/install-dependencies.md), + or use the Homebrew commands below. The skills do not install executables for + you. +2. **Add the instruction skills to your agent** using a direct or custom route + in the [host table](#install-in-your-agent). A curated marketplace listing + has its own approval process. +3. **Try a bounded search**, then explicitly capture an authored lesson with + the [checked example](docs/cli-workflows.md). Review the written memory + before using it elsewhere. + +The [v0.2.7 release](docs/distribution.md) +contains four skills and a Cursor integration archive under a signed tag. Its +[macOS ARM64 native qualification and independent review](docs/distribution.md#cursor-integration-release-gate) +pass for the exact release source; `productionSignoff` is +`PENDING_USER_SIGNOFF`. Automatic failure capture is unavailable. This release +and review do not establish Cursor Marketplace admission or qualify other +native platforms. + +## The four skills | Skill | Command family | Purpose | |---|---|---| @@ -11,13 +45,12 @@ Hermes Agent, skills.sh, Claude Code, and Grok Build. | `terraphim-agent-memory` | `terraphim-agent memory` | Save authored lessons, inspect saved content and source tags, and retrieve memory. | | `terraphim-editor` | Editor UI → `terraphim-grep` | Create and swap alternatives, export synonyms and search related decisions. | -These Apache-2.0 instruction skills do not bundle CLI executables, secrets, or -proprietary skill content. They remain useful without a marketplace account. -The [Cursor setup guide](integrations/cursor/README.md) provides a read-first -setup command and inactive optional integration examples. Installing the -instruction plugin does not activate MCP, hooks, rewriting or capture. Native -acceptance requires the matching release qualification record; source and -examples are not proof. The complete update cannot publish until native hooks pass. +These instruction skills do not bundle CLI executables, secrets, or proprietary +skill content. They remain useful without a marketplace account. The [Cursor +setup guide](integrations/cursor/README.md) provides a read-first command and +optional integration examples. Installing the instruction plugin does not +activate MCP, hooks, rewriting, or capture; each optional action requires its +own reviewed setup and matching qualification evidence. ## Install the command dependencies @@ -43,17 +76,22 @@ troubleshooting. The skills never install dependencies automatically. ## Install in your agent -| Host | Installation | -|---|---| -| Cursor | Use the local-copy instructions below. A prior marketplace submission is recorded; a public listing is not verified. | -| Kimi Code | Install this repository or add `marketplaces/kimi.json` as a custom marketplace. | -| AutoClaw | Import one checksummed ZIP per skill with **Skills & Connectors → Skills → Create → Add skill file**. | -| ZCode | Add `marketplaces/zcode.json` as a personal marketplace and install `terraphim-skills-intro`; curated listing is a separate maintainer-reviewed PR. | -| Hermes Agent | Add `terraphim/terraphim-cursor-plugin` as a tap, then inspect and install the four skills. | -| skills.sh | Run `npx skills add terraphim/terraphim-cursor-plugin`; use `DISABLE_TELEMETRY=1` to opt out of anonymous telemetry. | -| Claude Code | Add the repository as a marketplace, then install the plugin as shown below. | -| Kilo | Integration is being prepared; catalog admission and actual Kilo installation remain unqualified. | -| Grok Build | The marketplace submission pins the signed public release and is awaiting maintainer review; see the [distribution guide](docs/distribution.md) for status. | +The routes below describe installation methods, not v0.2.7 host acceptance. +The guide's historical v0.2.4 examples cover a three-skill pack; they do not +qualify the current four-skill release on non-Cursor hosts. The macOS ARM64 +Cursor native review passes, with production sign-off still pending. + +| Host | Direct or custom route | Curated status | +|---|---|---| +| Cursor | [Copy the repository locally](#local-cursor-installation). | Prior submission recorded; public listing unverified. | +| Kimi Code | Install the repository or add [`marketplaces/kimi.json`](marketplaces/kimi.json) as a custom marketplace. | Direct route documented; no curated claim. | +| AutoClaw | Import one checksummed ZIP per skill from the [release](docs/distribution.md) through **Skills & Connectors → Skills → Create → Add skill file**. | Local import documented; external catalog review is separate. | +| ZCode | Add [`marketplaces/zcode.json`](marketplaces/zcode.json) as a personal marketplace and install `terraphim-skills-intro`. | Curated listing awaits maintainer review. | +| Hermes Agent | Add `terraphim/terraphim-cursor-plugin` as a tap, then inspect and install the four skills. | Tap route documented; no curated claim. | +| skills.sh | Run `npx skills add terraphim/terraphim-cursor-plugin`; `DISABLE_TELEMETRY=1` opts out of anonymous telemetry. | Direct repository route documented. | +| Claude Code | Add this repository as a marketplace, then install the plugin as shown below. | Custom marketplace route documented. | +| Kilo | Integration is being prepared. | Catalog admission and actual Kilo installation unqualified. | +| Grok Build | The submission pins a signed release; see the [distribution guide](docs/distribution.md). | Awaiting maintainer review. | Claude Code commands: @@ -123,6 +161,11 @@ before enabling writes or configured model synthesis. ## Continue with Terraphim Skills +The skills can support an engineering workflow from research through validation. +The diagram shows that method; it is not an automatic feature of this plugin. + +![V-model showing research, design, specification, implementation, verification, and validation phases](assets/v-model-overview.svg) + Browse the [Community, Core, and Premium catalogue](https://terraphim-skills.md/skills/). The public introduction contains no proprietary instructions or entitlement token. Following a related-skill link never creates a checkout or transaction. Access and diff --git a/docs/distribution.md b/docs/distribution.md index 31b1c7f..26be0b1 100644 --- a/docs/distribution.md +++ b/docs/distribution.md @@ -1,12 +1,17 @@ # Multi-marketplace distribution -This repository is the canonical source for all hosts. The signed [v0.2.5 -release](https://github.com/terraphim/terraphim-cursor-plugin/releases/tag/v0.2.5) -contains four skills and deterministic AutoClaw archives, including the new -editor-to-search companion. Its public packages and original signatures have -been verified. The version-pinned host examples below retain their historical -`0.2.4` qualification; that earlier pack has three skills. A new source release -does not qualify a new host installation or Kilo catalog admission. +This repository is the canonical source for all hosts. The current signed +[v0.2.7 release](https://github.com/terraphim/terraphim-cursor-plugin/releases/tag/v0.2.7) +contains four skills, their AutoClaw archives, and a Cursor integration archive. +Its macOS ARM64 [native receipt](https://github.com/terraphim/terraphim-cursor-plugin/blob/1cf9d706c7dfd2d3078a8d5bb52f86cfd81ce1c4/qualification/cursor/0.2.7/native-receipt.json) +has a [passing independent review](https://github.com/terraphim/terraphim-cursor-plugin/blob/1cf9d706c7dfd2d3078a8d5bb52f86cfd81ce1c4/qualification/cursor/0.2.7/review.json) +for the exact release source; its `productionSignoff` is +`PENDING_USER_SIGNOFF`. Automatic failure capture is unavailable. + +The version-pinned host examples below retain their historical `v0.2.4` +qualification; that earlier pack has three skills. They are examples of a +previously checked host route, not v0.2.7 installation proof. A source release +does not qualify another host, native platform, or curated catalog admission. ## CLI workflows to include in every listing @@ -45,7 +50,7 @@ verified against the exact GitHub event commit before assets are published. The repository's active tag ruleset must restrict updates and deletions for `v*` so the tag cannot move between verification and release publication. -## Kimi Code +## Kimi Code (historical v0.2.4 route) Install the immutable release URL through Kimi Code's `/plugins install`, or open `/plugins marketplace` with @@ -57,7 +62,7 @@ confirm that exactly the three documented skills appear. The native manifest is releases whose shell-level `kimi plugin install` command expects that filename. Update by installing the newer tag; remove through Kimi's plugin manager. -## AutoClaw +## AutoClaw (historical v0.2.4 route) Download the three ZIP files and `SHA256SUMS` from the `v0.2.4` release. Verify each digest, then use **Skills & Connectors → Skills → Create → Add skill file**. @@ -65,7 +70,7 @@ Import each ZIP separately. Restart AutoClaw and confirm the skills persist. Rem them through the same Skills screen. If Homebrew binaries are missing from the GUI `PATH`, restart AutoClaw after installing the dependencies. -## ZCode +## ZCode (historical v0.2.4 route) Open ZCode's **Discover** view and add `https://raw.githubusercontent.com/terraphim/terraphim-cursor-plugin/v0.2.4/marketplaces/zcode.json` @@ -75,7 +80,7 @@ Skills view shows exactly three skills. Curated discovery requires a separate this repository does not claim acceptance before the maintainers merge it. Update or remove the installed plugin through ZCode's plugin manager. -## Hermes Agent +## Hermes Agent (historical v0.2.4 route) Add the repository as a GitHub tap, then inspect each skill before installing: @@ -89,7 +94,7 @@ hermes skills inspect terraphim/terraphim-cursor-plugin/skills/terraphim-agent-m Record the immutable `v0.2.4` provenance. Remove the skills with Hermes' normal skill-management command. -## skills.sh +## skills.sh (historical v0.2.4 route) Use an isolated agent target and run: @@ -197,11 +202,12 @@ publisher identity is available; no human token is copied into this repository. ## Cursor integration release gate The [read-first project setup](../integrations/cursor/README.md) requires the -matching release qualification record for native acceptance. Source/examples -are not proof. The user requires -**“Hold the update until hooks pass”**: editor/search/memory alone cannot release -this update. Optional rewriting/capture remain inactive, and automatic failure -capture is unavailable until its actual native result shape is qualified. +matching release qualification record for native acceptance. Source and +examples alone are not proof. The v0.2.7 macOS ARM64 review passes its recorded +native hook cases for the exact candidate, while production sign-off remains +pending. Later changes need their own qualification. Optional rewriting and +capture remain inactive until explicitly configured. Automatic failure capture +remains unavailable because its native result shape is unqualified. The shared pack uses the existing signed `v*` pipeline with an additive Cursor integration archive and matching checksum entry. Original signed skill