Skip to main content

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

Project description

Haxaml

PyPI version

Haxaml is an LLM-first governance layer for coding agents.

It gives agents one deterministic source of truth called FRAME and a strict MCP tool workflow so project context does not drift across sessions or tools.

What Haxaml Is For

Use Haxaml when an AI agent is doing implementation work and you want:

  • explicit project facts and rules
  • deterministic context handoff
  • verify/record gates before claiming success
  • stable MCP-native workflows instead of ad-hoc prompting

5-Minute Start

  1. Install:
pip install haxaml
# or
uv tool install haxaml
uv tool install haxaml-mcp
  1. Initialize FRAME:
haxaml init
haxaml validate
  1. Configure MCP client:
{
  "mcpServers": {
    "haxaml": {
      "command": "uvx",
      "args": ["haxaml-mcp"],
      "env": {
        "HAXAML_PROJECT_DIR": "/path/to/project"
      }
    }
  }
}
  1. For existing projects:
haxaml adopt-plan --dir .
haxaml reconcile --dir .
haxaml validate --dir .

For the practical lifecycle flow and failure recovery path, use MCP.md sections: Quick Start MCP Flow, Demo Walkthrough, Top 5 Troubleshooting, and Detail Mode Quick Examples.

Startup Prompt For Agent Files

Paste this at the top of your native agent file (AGENTS.md, CLAUDE.md, GEMINI.md, .github/copilot-instructions.md, etc.):

You are working in a repository governed by Haxaml.

Haxaml is the project governance source of truth for LLM agents.
Use Haxaml MCP tools directly instead of ad-hoc workflow decisions.

Operational contract:
1. Start with haxaml_guidance(task=...).
2. Open a governed run with haxaml_session_start(task=..., description=...).
3. Generate execution steps with haxaml_session_plan(session_id=...).
4. Pull only task-relevant context with haxaml_context_pack(task=...).
5. Before recording success/partial, run haxaml_session_verify(...).
6. Record outcomes using haxaml_session_record(...).
7. If boundary or derivation risk appears, run haxaml_reconcile(project_dir='.') and resolve conflicts first.

Adoption rule:
- For existing repos, run haxaml_adopt_plan(project_dir='.') first.
- Do not overwrite existing governance files unless explicitly requested.

Safety rule:
- Do not claim success if validation/reconcile gates are unresolved.

Core FRAME Files

  • .haxaml/facts.yaml - project truth
  • .haxaml/rules.yaml - agent operating rules
  • .haxaml/acts.yaml - execution diary and decisions
  • .haxaml/expect.yaml - run plan and milestones
  • .haxaml/map.yaml - optional module ownership and impact map

Docs

  • MCP.md - MCP-first operator guide with bootstrap-aligned config examples, Quick Start MCP Flow, demo walkthroughs, bad/good usage pairs, and troubleshooting
  • ADVANCED.md - deeper command and export behavior
  • LONGTERM.md - roadmap direction
  • CHANGELOG.md - release 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.5.tar.gz (96.2 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.5-py3-none-any.whl (86.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: haxaml-0.4.5.tar.gz
  • Upload date:
  • Size: 96.2 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.5.tar.gz
Algorithm Hash digest
SHA256 cf50f35c9277f2cb2f84317a95c945762ea7ac0606d109c0cdfbf3e7f1fd1a84
MD5 71c834c485c4fa9d8bc1348e257f9482
BLAKE2b-256 256d3b0c9249ad7101056dcac801407fd434002c3f7b4baba7db6645c3af38d0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: haxaml-0.4.5-py3-none-any.whl
  • Upload date:
  • Size: 86.0 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 f94b4ff6367b157c8b3325e556a93eb00a0cb8ac73abf9d941c4d1b60d59ef9b
MD5 ef051a48f85c3579c1644856ed17e4b1
BLAKE2b-256 17c8d675d5517c93ff11afcf301bae07fe7d40ebe648e5dcf3df2adb61eb5f64

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