mirror of
https://github.com/getcompanion-ai/co-mono.git
synced 2026-04-15 22:03:45 +00:00
6cc370c446
- skills.md: mention /settings and settings.json for toggling skill commands - prompt-templates.md: add Usage section with examples
67 lines
1.8 KiB
Markdown
67 lines
1.8 KiB
Markdown
> pi can create prompt templates. Ask it to build one for your workflow.
|
|
|
|
# Prompt Templates
|
|
|
|
Prompt templates are Markdown snippets that expand into full prompts. Type `/name` in the editor to invoke a template, where `name` is the filename without `.md`.
|
|
|
|
## Locations
|
|
|
|
Pi loads prompt templates from:
|
|
|
|
- Global: `~/.pi/agent/prompts/*.md`
|
|
- Project: `.pi/prompts/*.md`
|
|
- Packages: `prompts/` directories or `pi.prompts` entries in `package.json`
|
|
- Settings: `prompts` array with files or directories
|
|
- CLI: `--prompt-template <path>` (repeatable)
|
|
|
|
Disable discovery with `--no-prompt-templates`.
|
|
|
|
## Format
|
|
|
|
```markdown
|
|
---
|
|
description: Review staged git changes
|
|
---
|
|
Review the staged changes (`git diff --cached`). Focus on:
|
|
- Bugs and logic errors
|
|
- Security issues
|
|
- Error handling gaps
|
|
```
|
|
|
|
- The filename becomes the command name. `review.md` becomes `/review`.
|
|
- `description` is optional. If missing, the first non-empty line is used.
|
|
|
|
## Usage
|
|
|
|
Type `/` followed by the template name in the editor. Autocomplete shows available templates with descriptions.
|
|
|
|
```
|
|
/review # Expands review.md
|
|
/component Button # Expands with argument
|
|
/component Button "click handler" # Multiple arguments
|
|
```
|
|
|
|
## Arguments
|
|
|
|
Templates support positional arguments and simple slicing:
|
|
|
|
- `$1`, `$2`, ... positional args
|
|
- `$@` or `$ARGUMENTS` for all args joined
|
|
- `${@:N}` for args from the Nth position (1-indexed)
|
|
- `${@:N:L}` for `L` args starting at N
|
|
|
|
Example:
|
|
|
|
```markdown
|
|
---
|
|
description: Create a component
|
|
---
|
|
Create a React component named $1 with features: $@
|
|
```
|
|
|
|
Usage: `/component Button "onClick handler" "disabled support"`
|
|
|
|
## Loading Rules
|
|
|
|
- Template discovery in `prompts/` is non-recursive.
|
|
- If you want templates in subdirectories, add them explicitly via `prompts` settings or a package manifest.
|