Skip to main content

Deterministic agent-management framework that implements FRAME governance for AI-assisted software development.

Project description

Haxaml

PyPI version

Haxaml is a deterministic project-governance framework for AI coding workflows.

MCP first. CLI second.

It gives agents one shared source of truth called FRAME so context does not drift across tools.

What it does

  • keeps project truth in structured FRAME files
  • validates that structure before work starts
  • tracks runs, decisions, risks, and completed work
  • exports clean agent-ready prompt files from FRAME
  • exposes MCP tools so IDE agents can call governance directly

FRAME at a glance

File Purpose
.haxaml/facts.yaml project truth
.haxaml/rules.yaml how agents should work
.haxaml/acts.yaml task diary and decisions
.haxaml/expect.yaml expected next runs
.haxaml/map.yaml optional module ownership + impact map

Install

pip install haxaml

or with uv tools:

uv tool install haxaml
uv tool install haxaml-mcp

Quick start

haxaml init
haxaml validate
haxaml context --tokens
haxaml export

Default export writes HAXAML.md.

MCP-first lifecycle flow:

haxaml guidance --task "implement auth module"
haxaml session-start --task "implement auth module"
haxaml session-plan --session-id <id>
haxaml context-pack --task "implement auth module"
haxaml verify --task "implement auth module" --summary "what changed"
haxaml session-record --task "implement auth module" --result success

Adoption/reconcile flow for existing repos:

haxaml adopt-plan --dir .
haxaml reconcile --dir .
haxaml validate --dir .

Optional agent-specific exports:

haxaml export --agent claude
haxaml export --agent codex
haxaml export --agent copilot
haxaml export --agent cursor
haxaml export --agent windsurf
haxaml export --agent gemini

Safe preview before writing:

haxaml export --dry-run --diff-preview --target CLAUDE.md

MCP setup (recommended)

Use uvx in your MCP client config:

{
  "mcpServers": {
    "haxaml": {
      "command": "uvx",
      "args": ["haxaml-mcp"],
      "env": {
        "HAXAML_PROJECT_DIR": "/path/to/project"
      }
    }
  }
}

You can also generate project-local bootstrap config with:

haxaml mcp-bootstrap --mode write --editor generic

Upgrade

haxaml upgrade

Pin a specific version:

haxaml upgrade --to 0.4.0

Why FRAME even when markdown can be smaller?

In some fixtures, raw markdown is smaller than YAML. That is normal.

Haxaml is not only about raw token count. The value is deterministic governance:

  • validation gates
  • compact compiled exports
  • explicit decisions and risks
  • stable multi-agent handoff

Docs

  • MCP.md for MCP tool contracts, lifecycle, and structured response shapes.
  • ADVANCED.md for deeper command reference and export behavior.
  • LONGTERM.md for roadmap and major-version direction.
  • CHANGELOG.md for release notes and migration notes.

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

haxaml-0.4.0.tar.gz (88.5 kB view details)

Uploaded Source

Built Distribution

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

haxaml-0.4.0-py3-none-any.whl (80.1 kB view details)

Uploaded Python 3

File details

Details for the file haxaml-0.4.0.tar.gz.

File metadata

  • Download URL: haxaml-0.4.0.tar.gz
  • Upload date:
  • Size: 88.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for haxaml-0.4.0.tar.gz
Algorithm Hash digest
SHA256 f657498c6e258e08b9d0adf6b457197c650b9add56c214f46fb8a31fcb2b9233
MD5 d318c41edf39f87bd1fb9e4494cc8d78
BLAKE2b-256 22755db9c922f88fccc05b12c88ff1a8e1a16938814f477e0e87587b1b27f40f

See more details on using hashes here.

File details

Details for the file haxaml-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: haxaml-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 80.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for haxaml-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 62d6e86a82f27ebaef11524548d21aad9bbeefb9d69c070416933fac51189f8f
MD5 0d0679744e6783d98f43a1fc229a8e5a
BLAKE2b-256 8119fb3d04fe8ed111b4f27e993c88b9f1c884f37019a7aa9d2afa30ee853a57

See more details on using hashes here.

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