From 170bc6de66946bec963eaf18567f5c0e8e29e344 Mon Sep 17 00:00:00 2001 From: ducoterra Date: Fri, 21 Aug 2026 02:49:10 -0400 Subject: [PATCH] truncate README --- README.md | 39 +++++---------------------------------- 1 file changed, 5 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 9e16a7b..5d31586 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # pi Skills -This directory contains custom skills for [pi](https://github.com/earendil-works/pi), a coding agent harness. Each skill adds specialized capabilities that extend what pi can do. +This directory holds custom skills for [pi](https://github.com/earendil-works/pi), a coding agent harness. Each skill adds specialized capabilities that extend what pi can do. -## Installed Skills +## Current Skills | Skill | Description | |-------|-------------| @@ -10,44 +10,15 @@ This directory contains custom skills for [pi](https://github.com/earendil-works | [find-skills](./find-skills/) | Discovers and installs new skills | | [gog](./gog/) | Google Workspace CLI (Gmail, Calendar, Drive, Contacts, Sheets, Docs) | -## How Skills Work +## Adding a Skill -A skill is a directory containing at minimum a `SKILL.md` file. When pi loads, it reads all `SKILL.md` files in this directory and makes their instructions available to the agent. The `description` field in each skill's front matter tells pi when to activate that skill. - -Skills can include: -- **Scripts** — shell scripts, Node modules, or any executable code -- **Assets** — templates, prompts, validation gates, etc. -- **Additional docs** — referenced via relative paths from `SKILL.md` - -## Adding a New Skill - -1. Create a directory under `~/.pi/agent/skills//` -2. Add a `SKILL.md` with front matter and instructions -3. Optionally add scripts, assets, or subdirectories -4. Restart pi (or the skill will be picked up on next load) - -### SKILL.md Format - -```markdown ---- -name: my-skill -description: What this skill does — when pi should activate it ---- - -# My Skill - -Instructions for the agent go here. -``` - -## Cloning Skills from Other Sources - -To install a skill from a git repo or another location, you can clone it directly into this directory: +To install a skill from elsewhere, clone or symlink it into `~/.pi/agent/skills/`: ```bash git clone https://github.com/user/my-skill ~/.pi/agent/skills/my-skill ``` -Or symlink for development: +Or for development: ```bash ln -s /path/to/my-skill ~/.pi/agent/skills/my-skill