Skip to content

prompts.md

Latest commit

 

History

History
78 lines (54 loc) · 1.74 KB

prompts.md

File metadata and controls

78 lines (54 loc) · 1.74 KB
Raw

Prompt Templates

Prompt templates are Markdown files that expand with arguments when invoked as slash commands.

Setup

Place .md files in .rig/prompts/:

---
description: Explain a concept in detail
argument-hint: <concept>
---

Please explain $@.

The filename (without .md) becomes the command name. Invoke with /explain quicksort.

Frontmatter

Optional YAML frontmatter between --- markers:

Field Purpose
description Shown in autocomplete
argument-hint Usage hint shown alongside description

Substitution Syntax

Positional Arguments

Syntax Meaning
$1 First argument
$2 through $9 Nth argument
$@ or $ARGUMENTS All arguments joined with spaces

Missing positional arguments become empty strings.

Range Syntax

Syntax Meaning
${@:N} Arguments from position N to end (1-indexed)
${@:N:L} L arguments starting at position N

Example

Template (review.md):

---
description: Review code for issues
argument-hint: <file-path> [focus-area]
---

Review the code in $1 focusing on:
${@:2}

Usage: /review src/main.c security performance

Expands to:

Review the code in src/main.c focusing on:
security performance

Discovery

Templates are loaded from configured prompt directories. Only .md files directly in the directory are discovered (not recursive). First match wins if duplicates exist across directories.

Examples

See examples/prompts/ for working templates:

  • explain.md - Explain a concept in detail
  • review-code.md - Code review with specific focus areas
  • summarize.md - Concise summaries with length limits