truncate README

This commit is contained in:
2026-08-21 02:49:10 -04:00
parent 1b54998503
commit 170bc6de66
+5 -34
View File
@@ -1,8 +1,8 @@
# pi Skills # 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 | | 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 | | [find-skills](./find-skills/) | Discovers and installs new skills |
| [gog](./gog/) | Google Workspace CLI (Gmail, Calendar, Drive, Contacts, Sheets, Docs) | | [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. To install a skill from elsewhere, clone or symlink it into `~/.pi/agent/skills/`:
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/<name>/`
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:
```bash ```bash
git clone https://github.com/user/my-skill ~/.pi/agent/skills/my-skill git clone https://github.com/user/my-skill ~/.pi/agent/skills/my-skill
``` ```
Or symlink for development: Or for development:
```bash ```bash
ln -s /path/to/my-skill ~/.pi/agent/skills/my-skill ln -s /path/to/my-skill ~/.pi/agent/skills/my-skill