agentmux 1.0.0__tar.gz

agentmux-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Lint (ruff check)
+        run: ruff check src/
+
+      - name: Format check (ruff format)
+        run: ruff format --check src/
+
+      - name: Type check (mypy)
+        run: mypy src/
+
+      - name: Run tests with coverage
+        run: pytest --cov=agentmux --cov-report=xml --cov-report=term-missing
+
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        if: matrix.python-version == '3.12'
+        with:
+          name: coverage-report
+          path: coverage.xml

agentmux-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,76 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  validate:
+    name: Validate before publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Lint
+        run: ruff check src/
+
+      - name: Format check
+        run: ruff format --check src/
+
+      - name: Type check
+        run: mypy src/
+
+      - name: Run tests
+        run: pytest --cov=agentmux --cov-report=term-missing
+
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    needs: validate
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install build twine
+
+      - name: Build wheel and sdist
+        run: python -m build
+
+      - name: Check distribution
+        run: twine check dist/*
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: build
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

agentmux-1.0.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

agentmux-1.0.0/AGENTS.md

@@ -0,0 +1,212 @@
+# agentmux Developer Guide
+
+Canonical reference for AI coding agents and contributors working in this repository.
+
+---
+
+## Project Overview
+
+**agentmux** is a Python CLI tool that manages AI coding agent configurations (agents, commands,
+skills, rules, instructions, MCP configs) across multiple tools (Cursor, Gemini CLI, etc.) from a
+single canonical format (Markdown + YAML frontmatter). It is written in Python 3.10+, uses Pydantic
+v2 for data models, Click for the CLI, and Rich for terminal output.
+
+Package layout follows the `src/` convention:
+
+```
+src/agentmux/
+  adapters/   — Tool-specific adapters (Cursor, Gemini, …)
+  cli/        — Click CLI commands
+  core/       — Data models (component.py), config parser (setup.py), sync engine (sync.py)
+  utils/      — Frontmatter parser, symlink/file helpers
+tests/        — pytest test suite mirroring src layout
+```
+
+---
+
+## Environment Setup
+
+This project uses a `.venv` virtual environment. Activate it before running any commands:
+
+```bash
+source .venv/bin/activate
+```
+
+If it doesn't exist, create and populate it:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+---
+
+## Commands
+
+### Run all tests
+```bash
+pytest --cov=agentmux --cov-report=term-missing
+```
+
+### Run a single test file
+```bash
+pytest tests/test_sync.py
+```
+
+### Run a single test by name
+```bash
+pytest tests/test_sync.py::test_sync_cursor_creates_agent
+pytest -k "test_deep_merge_nested"
+```
+
+### Lint (check only)
+```bash
+ruff check src/
+```
+
+### Format (auto-fix)
+```bash
+ruff format src/
+```
+
+### Lint + format together
+```bash
+ruff check src/ && ruff format src/
+```
+
+### Type checking
+```bash
+mypy src/
+```
+
+### Run full quality check (do this before committing)
+```bash
+ruff check src/ && ruff format --check src/ && mypy src/ && pytest --cov=agentmux
+```
+
+---
+
+## Code Style
+
+### Formatting
+- Line length: **100 characters** (configured in `pyproject.toml`; E501 is ignored so ruff won't
+  error on it, but keep lines within 100 for readability).
+- Indentation: 4 spaces, no tabs.
+- Formatter: `ruff format` (Black-compatible).
+
+### Imports
+- **Absolute imports only** — never relative (`from agentmux.core.component import X`, not
+  `from .component import X`).
+- **Named imports** — no wildcard imports (`from module import *` is forbidden).
+- Declare `__all__` in every module that has a public API.
+- Use `TYPE_CHECKING` guards for imports that are only needed for type annotations to avoid
+  circular imports at runtime.
+- Lazy imports inside function bodies are acceptable in CLI commands to defer heavy loading.
+- Annotate untyped third-party packages with `# type: ignore[import-untyped]` (specific error
+  code, not a blanket `# type: ignore`).
+
+### Naming Conventions
+
+| Entity | Convention | Examples |
+|---|---|---|
+| Classes | `PascalCase` | `CursorAdapter`, `SyncAction`, `MCPConfig` |
+| Functions / methods | `snake_case` | `from_file()`, `sync_setup()`, `create_symlink()` |
+| Variables | `snake_case` | `raw_meta`, `mcp_path`, `sync_action` |
+| Module-private constants | `_SCREAMING_SNAKE` | `_FRONTMATTER_RE`, `_MAX_BACKUPS` |
+| Public Enum values | `SCREAMING_SNAKE` | `ComponentType.AGENT`, `InstallStrategy.SYMLINK` |
+| Private helpers | Leading `_` | `_deep_merge()`, `_deploy()`, `_cleanup_backups()` |
+| Type aliases | `PascalCase` | `Component = Agent \| Command \| ...` |
+
+Variable names must be **descriptive** — `raw_response_payload` not `data`; `user_index` not `x`.
+
+### Typing
+- Python 3.10+ union syntax: `Path | None`, `str | int`, not `Optional[str]` or `Union[str, int]`.
+- All public functions must have explicit **parameter and return type annotations**.
+- Use concrete generics throughout: `dict[str, Any]`, `list[str]`, `tuple[ToolAdapter, ...]`.
+- Mypy runs in **strict mode** — `disallow_untyped_defs` and all other strict flags are active.
+  New code must pass `mypy src/` cleanly with zero new errors.
+- Use `@dataclass` for internal data-transfer objects (no validation needed).
+- Use **Pydantic v2** models for all user-facing data with validation requirements.
+- Use `Literal["value"]` for constrained string fields instead of plain `str`.
+- Enums should inherit from `(str, Enum)` to make values directly JSON-serializable.
+- `Any` is acceptable in `dict[str, Any]` for unstructured YAML/JSON data, but document why.
+
+### Error Handling
+- **Fail loudly with context.** Wrap exceptions with human-readable messages before re-raising:
+  ```python
+  raise ValueError(f"Failed to load agent '{path}': {exc}") from exc
+  ```
+- **Always use `from exc` chaining** to preserve the original cause.
+- **Guard clauses over deep nesting.** Validate inputs at the top of a function and return/raise
+  early rather than wrapping the happy path in `if/else` blocks.
+- Use `click.UsageError` for user-facing config errors in CLI commands (produces clean output).
+- Use `sys.exit(1)` in CLI on unrecoverable errors — do not let raw exceptions propagate to the
+  user.
+- Broad `except Exception` is acceptable only when the intent is to record a structured error
+  result (e.g., `SyncAction("error", ...)`) rather than silently swallow failures.
+- Pydantic validation errors caught during `load_components()` must be re-raised as `ValueError`
+  with context.
+
+### Code Organisation
+- **Single Responsibility per module** — if a module does two things, split it.
+- Prefer **dispatch tables** (`dict[ComponentType, Callable]`) over long `if/elif` chains.
+- Keep adapter implementations fully self-contained — no shared mutable state between adapters.
+- `AdapterRegistry` uses class-level state; provide a `reset()` method for test teardown.
+
+---
+
+## Testing
+
+### Framework and tools
+- **pytest** with built-in `tmp_path` fixture for filesystem isolation.
+- `click.testing.CliRunner` for CLI command tests.
+- `monkeypatch` for patching (no external mocking libraries — `unittest.mock` is acceptable but
+  prefer `monkeypatch.setattr`).
+- `conftest.py` autouse fixture `reset_adapter_registry` clears the registry after every test.
+
+### Test organisation
+- Mirror the source layout: `tests/test_adapters/test_cursor.py` ↔
+  `src/agentmux/adapters/cursor.py`.
+- TOML fixture strings are **module-level constants** (e.g. `TOML_CURSOR_ONLY`), not inline.
+
+### Naming
+```
+test_<unit>_<what_it_verifies>
+# e.g.
+test_agent_from_file_with_frontmatter
+test_deep_merge_nested
+test_sync_cursor_creates_agent
+```
+Add a docstring on tests where the intent is not obvious from the name.
+
+### Assertions
+- Direct equality: `assert agent.name == "My Agent"`
+- Content checks: `assert "name: Helper" in content`
+- Error paths: `pytest.raises(ValueError, match="pattern")` — always supply `match`.
+- Boolean checks: `assert x` / `assert not x` — never `assertEqual`.
+
+### Before adding a test
+Check that coverage for the intended behaviour does not already exist. Search with:
+```bash
+rg "test_<keyword>" tests/
+```
+
+### After any code change
+Always run the full test suite to confirm nothing regressed:
+```bash
+pytest
+```
+
+---
+
+## Architecture Decisions
+
+- **Adapter pattern** is the extension point. Each tool adapter implements the `ToolAdapter` ABC.
+  New tool support = new file in `src/agentmux/adapters/`, registered via `AdapterRegistry`.
+- **Canonical format** is Markdown + YAML frontmatter. Adapters are responsible for all
+  format translation; the core never writes tool-specific syntax.
+- **`agentmux.toml`** is the user-facing config. `Setup.from_toml()` is the single parse entry
+  point; never read TOML elsewhere.
+- The sync engine returns structured `SyncAction` objects — it does not print or `sys.exit`.
+  Only the CLI layer surfaces results to the user.

agentmux-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Omer Sadeh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.