Canonical configuration manager for AI coding agent components
Project description
agentmux
agentmux is a CLI tool that manages AI coding agent configurations — agents, commands, skills, rules, instructions, and MCP servers — from a single canonical format (Markdown + YAML frontmatter) and syncs them across all your AI tools at once.
Write your agent configurations once. Deploy everywhere.
Supported Tools
| Tool | Agents | Commands | Skills | Rules | Instructions | MCP |
|---|---|---|---|---|---|---|
| Cursor | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Gemini CLI | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| OpenCode | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Claude Code | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
Installation
pip install agentmux
Or via Homebrew (using the agentmux tap):
brew install Omer-Sadeh/agentmux/agentmux
Quickstart
# 1. Initialize a new setup in your project directory
agentmux init
# 2. Create your first agent
agentmux new agent my-agent --description "My AI coding assistant"
# 3. Sync to all detected AI tools
agentmux sync
# 4. Check deployment status
agentmux status
How It Works
agentmux reads component files (Markdown with YAML frontmatter) from your setup directory and deploys them to each configured AI tool's global config location. Deployments use symlinks by default, so edits to your source files are instantly reflected everywhere.
Setup file (agentmux.toml)
[setup]
name = "my-setup"
version = "1.0.0"
[tools]
cursor = { enabled = true, strategy = "symlink" }
gemini = { enabled = true, strategy = "generate" }
[components]
agents = ["agents/*.md"]
commands = ["commands/*.md"]
skills = ["skills/*/SKILL.md"]
rules = ["rules/*.md"]
instructions = "instructions.md"
mcps = "mcp.json"
Agent file (agents/my-agent.md)
---
name: My Agent
description: A helpful coding assistant
---
You are a helpful AI coding assistant. Your job is to...
CLI Reference
| Command | Description |
|---|---|
agentmux init |
Initialize a new setup in the current directory |
agentmux new <type> <name> |
Scaffold a new component (agent, command, skill, rule, mcp) |
agentmux sync |
Sync all components to configured tools |
agentmux sync --dry-run |
Preview what would be synced |
agentmux status |
Show deployment status across all tools |
agentmux validate |
Validate configuration and all components |
agentmux install <source> |
Install a setup from a git URL or local path |
agentmux update [name] |
Pull and redeploy the latest version of an installed setup |
agentmux uninstall <name> |
Remove an installed setup and its deployed files |
agentmux diff [name] |
Show what changed since last install/update |
agentmux list |
List all installed setups |
agentmux rollback [name] |
Restore files to before the last sync |
agentmux watch |
Auto-sync on file changes |
agentmux doctor |
Check which AI tools are installed |
Sharing Setups
agentmux supports installing shared setups directly from git repositories:
# Install from GitHub
agentmux install https://github.com/user/my-agent-setup
# Preview before installing
agentmux install https://github.com/user/my-agent-setup --dry-run
# Keep it up to date
agentmux update my-agent-setup
Plugin System
Third-party tool adapters can be registered via Python entry points:
[project.entry-points."agentmux.adapters"]
my-tool = "my_package.adapter:MyToolAdapter"
agentmux will discover and load any installed adapter automatically.
Contributing
Contributions are welcome! Please open an issue or pull request on GitHub.
License
MIT — see LICENSE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file agentmux-1.0.0.tar.gz.
File metadata
- Download URL: agentmux-1.0.0.tar.gz
- Upload date:
- Size: 90.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f5b8809662157c4d1945e295d584c987e22fa4e54ececa53737c9e80d0d71e5a
|
|
| MD5 |
07d34c45c26275f71e264ccd71aef81b
|
|
| BLAKE2b-256 |
3b84e0303888c33d6572a91fb82b456e78ed87b0c011b0fa9db2313bc907006c
|
File details
Details for the file agentmux-1.0.0-py3-none-any.whl.
File metadata
- Download URL: agentmux-1.0.0-py3-none-any.whl
- Upload date:
- Size: 52.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
788de7aa98ce5312abfaca2812826d67a42c151ad0c7b95b59efa770fa0440c5
|
|
| MD5 |
4f37ef05263d137a8b7778bb6ae27916
|
|
| BLAKE2b-256 |
0027a3ef0917742cb7a3e72d0ac5c6823d1dd0773afd1fb6496e3a4d58efba33
|