mirror of
https://github.com/anthropics/claude-plugins-official.git
synced 2026-03-18 10:53:09 +00:00
6b70f99f76
P0 follow-up for EA-471. Updates plugin-dev teaching materials to stop recommending the commands/ directory layout for new plugins: - command-development/SKILL.md: add legacy banner at top pointing to skills/ format - create-plugin.md: update scaffolding to create skills/<name>/SKILL.md instead of commands/; mark commands/ as acceptable legacy alternative; update all examples, tables, and testing instructions - example-plugin: migrate example-command to skills/example-command/SKILL.md; keep commands/example-command.md with a legacy-format note; update README to reflect new preferred structure Both formats remain loaded identically — this is a documentation change only. Refs: anthropics/apps#26827 Co-authored-by: Henry Shi <henrys@anthropic.com>
40 lines
1.2 KiB
Markdown
40 lines
1.2 KiB
Markdown
---
|
|
description: An example slash command that demonstrates command frontmatter options (legacy format)
|
|
argument-hint: <required-arg> [optional-arg]
|
|
allowed-tools: [Read, Glob, Grep, Bash]
|
|
---
|
|
|
|
# Example Command (Legacy `commands/` Format)
|
|
|
|
> **Note:** This demonstrates the legacy `commands/*.md` layout. For new plugins, prefer the `skills/<name>/SKILL.md` directory format (see `skills/example-command/SKILL.md` in this plugin). Both are loaded identically — the only difference is file layout.
|
|
|
|
This command demonstrates slash command structure and frontmatter options.
|
|
|
|
## Arguments
|
|
|
|
The user invoked this command with: $ARGUMENTS
|
|
|
|
## Instructions
|
|
|
|
When this command is invoked:
|
|
|
|
1. Parse the arguments provided by the user
|
|
2. Perform the requested action using allowed tools
|
|
3. Report results back to the user
|
|
|
|
## Frontmatter Options Reference
|
|
|
|
Commands support these frontmatter fields:
|
|
|
|
- **description**: Short description shown in /help
|
|
- **argument-hint**: Hints for command arguments shown to user
|
|
- **allowed-tools**: Pre-approved tools for this command (reduces permission prompts)
|
|
- **model**: Override the model (e.g., "haiku", "sonnet", "opus")
|
|
|
|
## Example Usage
|
|
|
|
```
|
|
/example-command my-argument
|
|
/example-command arg1 arg2
|
|
```
|