About Plugins
Auggie supports a plugin system that allows you to extend its functionality with custom commands, subagents, rules, hooks, skills, and MCP server integrations. Plugins are distributed through marketplaces - Git repositories that contain collections of plugins.Interactive Plugin Browser
The easiest way to manage plugins is through the interactive plugin browser in Auggie’s TUI (Terminal User Interface).Opening the Plugin Browser
In interactive mode, use the/plugins slash command to open the plugin browser:
Plugin Browser Features
The plugin browser provides two main tabs: Marketplaces Tab- View all installed plugin marketplaces
- Add new marketplaces from GitHub repositories
- Update marketplaces to get the latest plugins
- Remove marketplaces you no longer need
- Browse plugins within each marketplace
- Toggle automatic marketplace updates (enabled by default)
- View all currently enabled plugins
- See plugin details including commands, agents, rules, hooks, and MCP servers
Automatic Marketplace Updates
By default, Auggie automatically updates all installed marketplaces in the background when you start the CLI in interactive mode. This ensures you always have access to the latest plugins without manually running update commands.How It Works
- Automatic: Updates run in the background when Auggie starts in TUI mode
- Silent: Failed updates are logged but never shown to the user
- Fast: 15-second global timeout ensures startup isn’t delayed
- Notifications: You’ll be notified when marketplaces are successfully updated
- Cleanup: Stale plugin entries are automatically removed after updates
Controlling Auto-Updates
You can enable or disable automatic updates through the plugin browser:- Open the plugin browser with
/plugins - Navigate to the Marketplaces tab
- Look for the “Automatic updates” toggle
- Toggle it on or off based on your preference
If your organization manages your settings file, the auto-update toggle may be locked and show a
(locked) indicator.Manual Updates
If you prefer to update marketplaces manually or have auto-updates disabled, you can still update at any time:Recommended Marketplaces
Projects can recommend specific marketplaces to team members by adding them to the project’s.augment/settings.json file. When you open a workspace that recommends marketplaces you haven’t installed, Auggie will prompt you to install them.
For Project Maintainers
To recommend marketplaces for your project, add therecommendedMarketplaces key to your project’s .augment/settings.json:
owner/repo matching the GitHub repository path.
For Users
When you open a workspace with recommended marketplaces:- After workspace indexing completes, you’ll see a prompt listing the recommended marketplaces
- Choose Install to clone all recommended marketplaces at once
- Choose Skip to dismiss the prompt for this workspace
.augment/settings.local.json as dismissed. You won’t be prompted again for those particular marketplaces, but if new recommended marketplaces are added to the project later, you’ll still be prompted for those. You can still manually install dismissed marketplaces at any time using the plugin browser or CLI commands.
After installing recommended marketplaces, any plugins listed in the project’s
enabledPlugins setting (in .augment/settings.json) will automatically be enabled. The enabledPlugins setting is a record mapping plugin IDs to true/false, e.g. {"enabledPlugins": {"my-plugin@my-marketplace": true}}.Plugin Settings Reference
The following settings control plugin marketplace behavior. These can be placed in the appropriate settings file depending on their scope.autoUpdateMarketplaces
Controls whether installed marketplaces are automatically updated in the background when Auggie starts in interactive mode.- Type:
boolean - Default:
true - File:
~/.augment/settings.json(user-level) - Configurable via: Plugin browser (
/plugins→ Marketplaces tab → “Automatic updates” toggle)
git pull on all installed marketplace repositories at startup to ensure you have the latest plugins.
recommendedMarketplaces
Specifies marketplaces that should be recommended to users when they open this workspace.- Type:
arrayof strings (format:"owner/repo") - Default:
[] - File:
<workspace>/.augment/settings.json(project-level only — values in user or local settings are ignored)
.augment/settings.json:
dismissedMarketplaces
Tracks which recommended marketplaces the user has chosen to skip. This setting is automatically managed by Auggie.- Type:
arrayof strings (format:"owner/repo") - Default:
[] - File:
<workspace>/.augment/settings.local.json(local project-level, gitignored) - Managed by: Auggie (automatically updated when user skips recommended marketplaces)
enabledPlugins
Controls which plugins are enabled. This setting is a record mapping plugin IDs to boolean values.- Type:
Record<string, boolean> - Default:
{} - File: Any settings file (user, project, or local — values are deep-merged across all tiers)
CLI Commands
The .augment-plugin Folder
The.augment-plugin folder is the core configuration directory for Auggie plugins and marketplaces. This folder contains manifest files that define the plugin or marketplace metadata and structure.
.claude-plugin is also supported for backwards compatibility with Claude Code plugins. See the Compatibility with .claude-plugin section for more details.Marketplace Manifest (marketplace.json)
Themarketplace.json file defines your marketplace and lists all available plugins for discovery:
Plugin Components
Plugins can provide multiple types of components:Custom Commands
Slash commands are Markdown files in thecommands/ directory. The filename becomes the command name (e.g., hello.md creates /plugin-name:hello):
Subagents
Specialized agents in theagents/ directory that Auggie can invoke for specific tasks:
Rules
Guidelines in therules/ directory that instruct the agent on coding standards:
Hooks
Event handlers that respond to Auggie events. Configure inhooks/hooks.json:
MCP Servers
Model Context Protocol integrations defined in.mcp.json or within plugin.json:
Skills
Agent Skills in theskills/ directory that extend Auggie’s capabilities:
Compatibility with .claude-plugin
Auggie’s plugin system is designed to be backwards compatible with Claude Code’s.claude-plugin format. This means:
- Directory Recognition: Auggie recognizes both
.augment-pluginand.claude-plugindirectories - Manifest Format: The
plugin.jsonschema is compatible between both systems - Component Structure: Commands, agents, hooks, MCP servers, and skills use the same directory layout
- Easy Migration: Existing Claude Code plugins work with Auggie with minimal or no changes
Using Claude Code Plugins
If you have an existing Claude Code plugin with a.claude-plugin folder, Auggie can use it directly:
Creating Compatible Plugins
To create plugins that work with both Auggie and Claude Code:- Use
.augment-pluginas the primary configuration folder (Auggie will also check for.claude-plugin) - Follow the same manifest schema for
plugin.json - Use the same directory structure for commands, agents, hooks, etc.
Creating a Marketplace
A marketplace is a GitHub repository that hosts one or more plugins. Anyone can create and share their own marketplace.Marketplace Structure
Hosting a Marketplace on GitHub
To share your marketplace publicly, host it on GitHub:Step 1: Create the Repository
- Create a new public GitHub repository
- Add your marketplace structure with
.augment-plugin/marketplace.json - Add your plugins in the
plugins/directory
Step 2: Add Plugin Manifests
Each plugin needs its own.augment-plugin/plugin.json:
Step 3: Add a README
Create a README.md to help users discover and understand your plugins:Step 4: Publish and Share
- Push your code to GitHub
- Share the repository path with users
- Users can add your marketplace with:
Example: Complete Marketplace Repository
See justinxu421/auggie-plugin for a complete example marketplace with:- Multiple plugins demonstrating different capabilities
- Commands, hooks, agents, rules, and MCP server configurations
- Proper manifest files and documentation
Environment Variables
Plugins can use these environment variables in their configurations:| Variable | Description |
|---|---|
${AUGMENT_PLUGIN_ROOT} | Path to the plugin’s root directory |
${AUGGIE_PLUGIN_ROOT} | Alias for AUGMENT_PLUGIN_ROOT |
${CLAUDE_PLUGIN_ROOT} | Alias for AUGMENT_PLUGIN_ROOT (for Claude Code compatibility) |
${WORKSPACE_ROOT} | Path to the current workspace/project |
- MCP server configurations (
plugin.jsonand.mcp.json) - Hook commands (
hooks/hooks.json)
hooks/hooks.json:
Best Practices
For Plugin Authors
- Use semantic versioning for your plugin versions
- Add descriptive metadata in your manifest files
- Include a README with installation and usage instructions
- Test locally before publishing using
--plugin-dir:
For Marketplace Maintainers
- Organize plugins by category in your marketplace
- Use tags to help users discover plugins
- Keep the marketplace updated by pulling the latest changes
- Document each plugin with clear descriptions
See Also
- Custom Commands - Create reusable command templates
- Subagents - Create specialized agents
- Hooks - Automate actions with event hooks
- Integrations - Connect external tools and services
- Interactive Mode - Learn about Auggie’s TUI features