diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e66d77aa..3c3a015b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -72,6 +72,14 @@ Before proposing a change, search the [skill-change rejection ledger](evals/skil If a skill or description change is rejected based on eval results, add one row to the ledger with the date, affected skill, concise attempted change, before-to-after rank-1 score, and rejected PR link and outcome. Land that ledger-only update separately on the default branch; do not leave it only on the rejected proposal branch, where closing or force-pushing the proposal could discard the record. +## Adding a Host Guide + +The README install section lists only hosts a maintainer has installed and run the current release on. Every other host gets one line in [docs/other-hosts.md](docs/other-hosts.md): the host name and its install command. No dedicated setup page, vendor links, logos, emoji, or screenshots. + +- If you work for the company behind the host, say so in the PR. +- A host moves into the README once a maintainer has run it and is willing to keep its entry current. +- Host guides are reviewed in the order they were opened. + ## Repo-scoped files `AGENTS.md` and `CLAUDE.md` at the repo root configure agents working on the [`addyosmani/agent-skills`](https://github.com/addyosmani/agent-skills) repository itself. When writing setup guides or docs, do not instruct users to copy these files into their own projects or into a global agent configuration; the reusable assets are the skills in `skills/`. diff --git a/README.md b/README.md index a2483ded..c6039f4d 100644 --- a/README.md +++ b/README.md @@ -97,20 +97,6 @@ claude --plugin-dir /path/to/agent-skills -
-Oh My Pi (OMP) - -OMP installs this repository's Claude Code marketplace plugin: - -```bash -omp plugin marketplace add addyosmani/agent-skills -omp plugin install agent-skills@addy-agent-skills -``` - -Restart OMP after installation; skills are discovered from their descriptions. See [docs/omp-setup.md](docs/omp-setup.md) for local clones and the OMP tool mapping. - -
-
Cursor @@ -201,21 +187,6 @@ The first command registers the marketplace; the second installs the plugin. Cod
-
-Dojo Workspace - -Installing Dojo Workspace puts the `dojo` command on your PATH: - -```bash -dojo skills add addyosmani/agent-skills -``` - -If `dojo` is not on your PATH, add its install folder: `~/.local/bin` on macOS/Linux (`~/.local/bin/dojo`) or `%LOCALAPPDATA%\dojo\bin` on Windows (`dojo.exe`). Or run the binary by its full path. - -Skills install into `~/.agents/skills/`; enable the ones you want for each lane (Dojo Solo / Dojo Duo). Add `-p` to install into the current project's `.agents/skills/` instead. You can also install from the app's **Skills** panel → **Add External Skills**. See [docs/dojo-setup.md](docs/dojo-setup.md). - -
-
Command Code @@ -234,7 +205,7 @@ Installed skills show up in the TUI slash menu, e.g. `/spec-driven-development`.
Other Agents -Skills are plain Markdown - they work with any agent that accepts system prompts or instruction files. See [docs/getting-started.md](docs/getting-started.md). +Skills are plain Markdown - they work with any agent that accepts system prompts or instruction files. See [docs/getting-started.md](docs/getting-started.md). Hosts that install the pack but aren't listed above are in [docs/other-hosts.md](docs/other-hosts.md).
diff --git a/docs/dojo-setup.md b/docs/dojo-setup.md deleted file mode 100644 index 57ef7a9e..00000000 --- a/docs/dojo-setup.md +++ /dev/null @@ -1,45 +0,0 @@ -# ⛩️ Using agent-skills with Dojo Workspace - -Dojo Workspace is a desktop app that reads skills from the standard `.agents/skills/` folders. Installing it also puts the `dojo` command on your PATH. - -If `dojo` is not found, add its install folder to your PATH, or run it by its full path: - -| OS | Folder to add to PATH | Full path | -| --- | --- | --- | -| macOS / Linux | `~/.local/bin` | `~/.local/bin/dojo` | -| Windows | `%LOCALAPPDATA%\dojo\bin` | `%LOCALAPPDATA%\dojo\bin\dojo.exe` | - -Open a new terminal after the first app launch so the PATH change is picked up. - -## Install for all projects - -```bash -dojo skills add addyosmani/agent-skills -``` - -Skills install into `~/.agents/skills/` and appear in the **Skills** panel under the `addyosmani-agent-skills` group. Enable the ones you want for each lane (Dojo Solo or Dojo Duo). - -## Install for one project - -Run from the project root: - -```bash -dojo skills add -p addyosmani/agent-skills -``` - -Skills install into the project's `.agents/skills/` and are enabled for that project. Commit `skills-lock.json` to share them with your team. - -## Manage - -```bash -dojo skills list # add -p for the current project -dojo skills remove addyosmani/agent-skills -``` - -`remove` takes a whole repo or a single skill name. - -## How skills load - -Only each skill's name and description are listed for the model. The full `SKILL.md` loads on demand when a task matches, so enabling many skills stays cheap. Dojo also reads project instructions from `AGENTS.md`. - -If you'd rather add skills through the app's UI, [here is how](https://heydojo.ai/learn/dojo-skills-teach-your-agent-new-workflows). diff --git a/docs/omp-setup.md b/docs/omp-setup.md deleted file mode 100644 index 630cc4e1..00000000 --- a/docs/omp-setup.md +++ /dev/null @@ -1,41 +0,0 @@ -# Using agent-skills with Oh My Pi - -[Oh My Pi (OMP)](https://github.com/can1357/oh-my-pi) installs Claude Code marketplace plugins, so it uses this repository's existing `.claude-plugin/` manifests and the root `skills/` directory. No OMP-specific files are needed. - -## Install - -```bash -omp plugin marketplace add addyosmani/agent-skills -omp plugin install agent-skills@addy-agent-skills -``` - -The first command registers this repository as the `addy-agent-skills` marketplace. The second installs the `agent-skills` plugin from it. Restart OMP, or run `/reload-plugins` in an open session, so the skills are discovered. - -Local clones work too: - -```bash -omp plugin marketplace add /path/to/your/clone -omp plugin install agent-skills@addy-agent-skills -``` - -Check the result with `omp plugin list`. - -## Usage - -Describe the task and let OMP pick the skill. OMP lists each skill's `name` and `description` in its system prompt and loads the full `SKILL.md` only when a skill is selected. To select a skill explicitly, use `/skill:spec-driven-development` (available unless `skills.enableSkillCommands` is disabled), or ask the agent to read `skill://spec-driven-development`. - -OMP already routes skills natively. Do not also paste `using-agent-skills/SKILL.md` into `AGENTS.md`, `APPEND_SYSTEM.md`, a rule, or an extension that adds it to every run. That stacks the pack's meta-router on OMP's own router; see [Getting Started](getting-started.md). - -The same install also loads the slash commands and the personas in `agents/`. OMP namespaces plugin commands, so run `/agent-skills:spec`, `/agent-skills:ship`, and so on; a bare `/spec` is not expanded. The personas (`code-reviewer`, `security-auditor`, `test-engineer`, `web-performance-auditor`) are listed as `task` agents, which `/agent-skills:ship` and `/agent-skills:webperf` dispatch. - -## Tool mapping - -Skills and docs in this pack use Claude Code tool names. In OMP, use the native equivalents: - -| Skill instruction | OMP equivalent | -| --- | --- | -| Invoke another skill | `read` on `skill://`, or `/skill:` from the prompt | -| Spawn a subagent (`Agent` tool) | the `task` tool; only use agents OMP lists | -| Track tasks (`TodoWrite`) | the `todo` tool | -| Ask the user a question (`AskUserQuestion`) | the `ask` tool | -| Read, edit, write, search files | the native `read`, `edit`, `write`, `grep`, and `glob` tools | diff --git a/docs/other-hosts.md b/docs/other-hosts.md new file mode 100644 index 00000000..c81195fc --- /dev/null +++ b/docs/other-hosts.md @@ -0,0 +1,7 @@ +# Other hosts + +These hosts install the pack but are not in the README's install section, because no maintainer has run the current release on them. Each entry is one line: the host and its install command. To add one, see [Adding a Host Guide](../CONTRIBUTING.md#adding-a-host-guide). + +Skills are plain `SKILL.md` folders, so any agent that reads the Agent Skills layout can load them. See [getting-started.md](getting-started.md). + +- **Oh My Pi**: `omp plugin marketplace add addyosmani/agent-skills`, then `omp plugin install agent-skills@addy-agent-skills`