Skip to main content

About Custom Commands

Custom commands are user-defined slash commands stored as .md files. They appear in the / autocomplete menu in chat, letting you quickly invoke frequent prompts, templates, or workflows without retyping them.
Custom commands are available in JetBrains 0.428.8+ as a Public Beta opt-in from the Settings page.

Creating a Command

1

Create the commands directory

mkdir -p .augment/commands
2

Create a command file

Create .augment/commands/review.md:
---
description: Review code for bugs, security issues, and best practices
argument-hint: <file or description>
---

Review the following code carefully. Check for:
1. Bugs and logic errors
2. Security vulnerabilities
3. Performance issues
4. Adherence to project conventions

$ARGUMENTS
3

Use the command

Type /review in the chat input to invoke your command.

Command File Format

Each command is a Markdown file (.md) with optional YAML frontmatter:

Frontmatter Fields

FieldDescriptionDefault
descriptionBrief description shown in the autocomplete menuFirst line of the prompt
argument-hintHint for expected arguments, displayed after the command nameNone
modelOverride the default model for this commandDefault model

Template Substitution

Commands support template variables that are replaced when the command is invoked:
VariableDescription
$ARGUMENTSReplaced with any text typed after the command name
{placeholder}Prompts the user to fill in the value
{{placeholder}}Alternative syntax for placeholders

Command Locations

Commands can be scoped per-user or per-project:
LocationScopeDescription
<workspace>/.augment/commands/ProjectShared with your team via version control
~/.augment/commands/UserAvailable across all workspaces

Importing Commands

Augment also discovers commands from other tools for compatibility:
LocationSource
.claude/commands/Claude Code (workspace)
~/.claude/commands/Claude Code (user)
.cursor/commands/Cursor
This lets you reuse existing command libraries without migration.

Namespacing

Organize commands in subdirectories. A file at .augment/commands/frontend/component.md creates the command /frontend:component.

CLI Usage

Custom commands are also available in the Auggie CLI:
# Run a command
auggie command review

# List all available commands
auggie command list
For more details on CLI usage, see Custom Commands in the CLI.

Best Practices

  1. Use clear names — choose descriptive kebab-case names like deploy-staging or security-review
  2. Add descriptions — include a description in frontmatter for better discoverability in the autocomplete menu
  3. Use $ARGUMENTS — make commands flexible by accepting dynamic input
  4. Scope appropriately — use project commands for team workflows, user commands for personal shortcuts
  5. Organize with directories — group related commands using subdirectory namespacing

See Also