Skip to main content

agentmux

PyPI version Python versions CI License: MIT

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.

Release files for agentmux 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for agentmux 1.0.2
File Size Uploaded
agentmux-1.0.2.tar.gz 90.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for agentmux 1.0.2
File Interpreter ABI Platform
agentmux-1.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 143.0 kB

Release files / agentmux-1.0.2.tar.gz

Download URL agentmux-1.0.2.tar.gz
Size 90.8 kB
Tags Source
SHA-256 checksum
How to use checksums
a35fd13ba2d9098c26c7f7cb7560c1021b24e9ee497c3f37bf5fe4ab23b1e91b
BLAKE2b-256 checksum
How to use checksums
c1fc0a8ef3d9a4ed8551775e9143244b905412804403b2ef12fcfd483fd59c8e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / agentmux-1.0.2-py3-none-any.whl

Download URL agentmux-1.0.2-py3-none-any.whl
Size 52.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8374266a1258d3b641bc1c6a0eeb81b623e7c640cb565d47565da1f00e4252b8
BLAKE2b-256 checksum
How to use checksums
8368b62f412ca8ce6aa4bb333e75f4bfce43a10d0a356e01fbda6fd4f6b4b1aa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

1.0.2 This release

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page