diff options
Diffstat (limited to 'website/src/content/docs/agent-skill.mdx')
| -rw-r--r-- | website/src/content/docs/agent-skill.mdx | 67 |
1 files changed, 0 insertions, 67 deletions
diff --git a/website/src/content/docs/agent-skill.mdx b/website/src/content/docs/agent-skill.mdx deleted file mode 100644 index d6fe6a14..00000000 --- a/website/src/content/docs/agent-skill.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: Agent skill file -description: Install Herdr instructions for Claude Code or another coding agent. ---- - -Herdr ships a reusable agent skill file at [`skills/herdr/SKILL.md`](https://github.com/herdrdev/herdr/blob/master/skills/herdr/SKILL.md). - -Install that file into any coding agent that supports reusable skills or custom instructions. The skill teaches the agent how to control Herdr from inside a Herdr pane. - -Herdr also serves a separate guide at [`herdr.dev/agent-guide.md`](https://herdr.dev/agent-guide.md) for a different job: an agent helping a human learn, set up, or troubleshoot Herdr. The skill is for an agent operating Herdr; the guide is for an agent teaching a human. - -## What the skill does - -The skill tells an agent to use the `herdr` CLI when `HERDR_ENV=1` is set. That means the agent is running inside a Herdr-managed pane and can safely talk to the local Herdr socket. - -With the skill installed, an agent can: - -- inspect workspaces, tabs, panes, and neighboring agents -- split panes and run commands without stealing focus -- read pane output and recent logs -- wait for servers, tests, or another agent to finish -- start helper agents in sibling panes - -The skill is not a separate app or service. It is a markdown instruction file for agents. - -## Install it - -Install the skill with `npx skills`: - -```bash -npx skills add herdrdev/herdr --skill herdr -g -``` - -If you installed the skill while it lived at the repository root, rerun this add command once instead of using `skills update`. The add command replaces the oversized copy and records the new location. - -The `-g` flag installs it globally for supported agents. Omit `-g` to install it into the current project. - -Use the repository copy as the manual fallback and source of truth: - -```text -https://github.com/herdrdev/herdr/blob/master/skills/herdr/SKILL.md -``` - -For agents with a skill system, install that file as a skill named `herdr`. For agents without a skill system, paste the file into the agent's project or user instructions. - -After installation, start the agent inside Herdr: - -```bash -herdr -claude -``` - -Or use any other coding agent in a Herdr pane. The important part is that the agent process runs inside Herdr, so `HERDR_ENV=1` is available. - -## Safety rule - -The skill starts with one guardrail: if `HERDR_ENV=1` is not set, the agent should stop and say it is not running inside a Herdr-managed pane. - -This prevents an agent outside Herdr from trying to control a session it does not own. - -## Agent-facing reference - -The full command guide lives in the skill file itself. It covers pane IDs, `pane split`, `pane run`, `pane read`, `pane wait-output`, `agent wait`, workspace and tab commands, and coordination recipes. - -Read the source file here: - -[Open `SKILL.md` on GitHub →](https://github.com/herdrdev/herdr/blob/master/skills/herdr/SKILL.md) |