aboutsummaryrefslogtreecommitdiff
path: root/docs/versions/0.6.2/website/src/content/docs/agent-skill.mdx
diff options
context:
space:
mode:
Diffstat (limited to 'docs/versions/0.6.2/website/src/content/docs/agent-skill.mdx')
-rw-r--r--docs/versions/0.6.2/website/src/content/docs/agent-skill.mdx55
1 files changed, 55 insertions, 0 deletions
diff --git a/docs/versions/0.6.2/website/src/content/docs/agent-skill.mdx b/docs/versions/0.6.2/website/src/content/docs/agent-skill.mdx
new file mode 100644
index 00000000..fc4f0589
--- /dev/null
+++ b/docs/versions/0.6.2/website/src/content/docs/agent-skill.mdx
@@ -0,0 +1,55 @@
+---
+title: Agent skill file
+description: Install Herdr instructions for Claude Code or another coding agent.
+---
+
+Herdr ships a reusable agent skill file at [`SKILL.md`](https://github.com/ogulcancelik/herdr/blob/master/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.
+
+## 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
+
+Use the repository copy as the source of truth:
+
+```text
+https://github.com/ogulcancelik/herdr/blob/master/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`, `wait output`, `wait agent-status`, workspace and tab commands, and coordination recipes.
+
+Read the source file here:
+
+[Open `SKILL.md` on GitHub →](https://github.com/ogulcancelik/herdr/blob/master/SKILL.md)