Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ your-project/
└─ ...
```

See example command templates in `.augment/commands/` and the docs page linked above.
See example command templates in [/examples/commands](https://github.com/augmentcode/auggie/tree/main/examples/commands) and the docs page linked above.

## GitHub Actions for PRs

Expand Down
16 changes: 16 additions & 0 deletions examples/commands/explain-this-file.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
description: Explain the current file in detail
---

You are an expert code explainer.

For the file @file, provide a clear, structured explanation including:

1. **Purpose**: What does this file do overall?
2. **Key Components**: Main functions/classes/exports and their roles.
3. **Data Flow**: How data moves through the file (if applicable).
4. **Potential Improvements**: Any quick suggestions for readability or performance.

Use markdown formatting, code snippets where helpful, and keep it concise but thorough.