Skip to main content

Git workflow automation for AXM agents

Project description

AXM Logo

axm-git — Deterministic Git workflows for AI agents

CI axm-audit axm-init Coverage PyPI Python 3.12+ Docs


Features

  • 🔍 Preflight — Structured working tree status with diff summary
  • 🌿 Branch — Create or checkout branches with one call
  • 📦 Commit — Batched atomic commits with auto-retry on pre-commit fixes
  • 🏷️ Tag — One-shot semver tagging from Conventional Commits
  • 🚀 Push — Push with dirty-check, auto-upstream detection, and force support
  • 🧭 Error Recovery — When called on a non-git directory, tools suggest nearby git repos
  • 🪝 Hooks — Lifecycle hook actions (create-branch, commit-phase, merge-squash) with enabled guard, auto-discovered via entry-points
  • 🔎 Phase Lookupget_phase_commit() retrieves commit hashes for protocol phases

Installation

uv add axm-git

Quick Start

# Check what changed
git_preflight(path="/path/to/repo")
# → {files: [{path: "foo.py", status: "M"}, ...], clean: false}

# Create or switch branch
git_branch(name="feat/new-feature", path="/path/to/repo")
# → {branch: "feat/new-feature"}

# Commit in batches
git_commit(path="/path/to/repo", commits=[
    {"files": ["src/foo.py"], "message": "feat: add foo"},
    {"files": ["tests/test_foo.py"], "message": "test: add foo tests"},
])
# → {results: [{sha: "abc1234", precommit_passed: true}, ...]}

# Tag a release
git_tag(path="/path/to/repo")
# → {tag: "v0.2.0", bump: "minor", pushed: true}

# Push to remote
git_push(path="/path/to/repo")
# → {branch: "main", remote: "origin", pushed: true}

MCP Tools

git_preflight

Report working tree changes so the agent can plan commits.

Parameter Default Description
path . Project root directory
diff_lines 200 Max diff lines to include (0 to disable)

Returns: file list with status (M, A, D, ??), diff stat, clean flag.

git_branch

Create or checkout a git branch.

Parameter Default Description
name required Branch name
from_ref None Ref to branch from (tag, commit, branch)
checkout_only False If True, checkout existing branch without creating
path . Project root directory

Returns: {branch: "<current branch>"} on success.

git_commit

Execute one or more atomic commits with pre-commit hook handling.

Parameter Default Description
path . Project root directory
commits required List of commit specs (see below)

Each commit spec:

Field Required Description
files Files to stage
message Commit summary (Conventional Commits)
body Extended commit body

When a pre-commit hook auto-fixes files (e.g. ruff --fix), the tool re-stages and retries once automatically.

git_tag

Compute the next semver version from Conventional Commits, create and push the tag.

Parameter Default Description
path . Project root directory
version auto Override the computed version (e.g. "v1.0.0")

Pipeline: clean tree check → CI status check → semver bump → annotate tag → hatch-vcs verify → push.

git_push

Push the current branch to a remote after verifying a clean working tree.

Parameter Default Description
path . Project root directory
remote origin Remote name
set_upstream True Auto-set upstream for new branches
force False Force-push

Pipeline: repo check → dirty check → detect branch → detect upstream → push.

Development

This package is part of the axm-forge workspace.

git clone https://github.com/axm-protocols/axm-forge.git
cd axm-forge
uv sync --all-groups
uv run --package axm-git --directory packages/axm-git pytest -x -q

📖 Full documentation

License

Apache-2.0 — © 2026 axm-protocols

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

axm_git-0.1.0.tar.gz (34.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

axm_git-0.1.0-py3-none-any.whl (24.9 kB view details)

Uploaded Python 3

File details

Details for the file axm_git-0.1.0.tar.gz.

File metadata

  • Download URL: axm_git-0.1.0.tar.gz
  • Upload date:
  • Size: 34.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for axm_git-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f1a2acbfdc9c3cae8efcd6e9008c50b4f4931bcda7e1d74b23dffd624920ea2b
MD5 88a002b4bb55373cad5ddb23c31044a0
BLAKE2b-256 39f9d09998b24c2c0f4dacdf2f831e36c95463dd9a52652d857600660ae0df7f

See more details on using hashes here.

Provenance

The following attestation bundles were made for axm_git-0.1.0.tar.gz:

Publisher: publish.yml on axm-protocols/axm-forge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file axm_git-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: axm_git-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 24.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for axm_git-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d1677d5306f3579c72c140614dce738ab00299f327ca1a6a54e8b81095bdcc36
MD5 5b8289c4dcc5621c638215ca05c4f074
BLAKE2b-256 e4798e034ec38529e39988d65997531637339314ad79661bc88274029cbd6c9c

See more details on using hashes here.

Provenance

The following attestation bundles were made for axm_git-0.1.0-py3-none-any.whl:

Publisher: publish.yml on axm-protocols/axm-forge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page