David Heinemeier HanssonandClaude Fable 5
c2d81220d9
Keep only universal rules in AGENTS.md and point to per-task guides for shell development, acceptance tests, visual verification, command metadata, and install scripts. Fold the migration notes into docs/migrations.md and replace .claude/CLAUDE.md with a root CLAUDE.md importing AGENTS.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
32 lines
1.2 KiB
Markdown
32 lines
1.2 KiB
Markdown
# Command Metadata
|
|
|
|
Read this before adding or changing commands in `bin/`.
|
|
|
|
Commands in `bin/` can declare CLI metadata in comments near the top of the
|
|
file. `bin/omarchy` scans the first 80 lines, and tests expect command metadata
|
|
to remain valid.
|
|
|
|
Supported metadata keys:
|
|
|
|
- `# omarchy:group=...` - override the command group inferred from the filename
|
|
- `# omarchy:name=...` - override the command name inferred from the filename
|
|
- `# omarchy:summary=...` - short help text
|
|
- `# omarchy:args=...` - usage arguments
|
|
- `# omarchy:examples=...` - examples separated with ` | `
|
|
- `# omarchy:alias=...` / `# omarchy:aliases=...` - alternate routes
|
|
- `# omarchy:hidden=true` - hide from default command listings
|
|
- `# omarchy:requires-sudo=true` - mark commands that require sudo
|
|
|
|
Only use `omarchy:examples` where there are args that need explaining.
|
|
|
|
Prefer explicit metadata for user-facing commands. Keep routes consistent with
|
|
the filename unless there is a deliberate alias or compatibility route.
|
|
|
|
Example:
|
|
|
|
```bash
|
|
# omarchy:summary=Take a screenshot
|
|
# omarchy:args=[smart|region|windows|fullscreen] [slurp|copy]
|
|
# omarchy:examples=omarchy screenshot | omarchy capture screenshot region
|
|
```
|