wehub-resource-sync
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
|
|
```
|