Skip to main content

Archkeel

Architecture checks for coding agents.

Python 3.11+ CI PyPI MIT

Archkeel checks code against your architecture rules. It shows forbidden imports, misplaced types, and gaps in the analysis, with source evidence you can review. It runs locally and in CI. The checks are deterministic; they do not call an LLM.

In a coding-agent harness, Archkeel supplies architecture feedback before submission. Tests check behavior. Archkeel checks declared boundaries and whether a change made static analysis less complete. Both still need human review.

Start here

Requires Python 3.11+ and a Git repository with at least one commit. Run Archkeel with a Python version that meets your project's requirements.

uv tool install archkeel
archkeel skill install codex    # or claude

Then ask your coding agent:

Set up Archkeel for this repository. Read the architecture documents,
propose the boundaries, and let me decide which dependencies are allowed.

The skill guides the setup. init drafts components and interfaces; you decide the target architecture. Existing imports are evidence, not permission. You can delegate decisions to the agent, but its authorship is recorded separately. See the onboarding guide for setup and plugin installation.

For an existing setup:

archkeel report      # inspect code and evidence
archkeel validate    # check the contract

report writes architecture.json and an offline architecture.report.html. Read the verdicts: a report can exit 0 with failed or undecided rules. validate checks the contract; check also compares a submitted change with its published expectation. Use archkeel <command> --help for command options.

Review the evidence

Shop report with scan status, failed rules and separate verdicts

Use the report to inspect findings and source locations, then explore the components. Filters narrow the view without changing the verdicts.

archkeel report --only violations --component store
archkeel report --only calls --component store

The explorer shows Actual (observed code), Target (declared architecture), and Diff (their differences). These are views of one snapshot, not two revisions. Folders help navigation; they do not establish ownership or runtime behavior.

PASS means the required rules have complete evidence and no decided violation. UNKNOWN means evidence is missing. A rule can fail and still have undecided positions. A clean graph does not prove a good design.

Catch changes that finding diffs miss

This change adds no forbidden import or cycle, but makes a call harder to resolve:

 def run(key: str) -> int:
-    return first() + second()
+    handlers = {"first": first, "second": second}
+    return handlers[key]()

In Fixture A, resolved calls drop from 2 of 2 to 0 of 1. New finding fingerprints stay at zero. Archkeel rejects the candidate because unresolved calls increase from 0 to 1.

check compares the accepted and candidate commits, checks the contract, and verifies the candidate against an expectation published before submission. Publication order needs trusted host records. A local replay checks supplied records without authenticating them. The reference explains the commit protocol and its limits.

Keep a target the code has not reached

Record existing violations, review the file, then reject new ones in CI:

archkeel validate --baseline known-violations.json --write-baseline
archkeel validate --baseline known-violations.json

Known violations remain FAIL. After fixing them, rewrite the baseline in the same change. New or increased violations require explicit --accept-new; do not use it to hide a regression. See the target-first guide for the full workflow.

Try a reproducible example

git clone https://github.com/rapiddweller/archkeel.git
cd archkeel
make demo
make demo-onboarding

make demo rejects a coverage regression and a late expectation, then shows a passing candidate. make demo-onboarding replays setup on a two-level shop using committed decision fixtures; it performs no live approvals. More cases are in the demo catalog.

Scope and limits

Archkeel observes static source in configured roots. Python support covers imports, calls, and declared boundaries; Dart support currently covers imports. It does not prove runtime behavior, performance, or the quality of every design decision. Separate test trees need their own scan and contract.

Exit Meaning
0 Complete report or successful check; read the individual verdicts
1 Rejected, including a baseline that needs updating
2 Input or evidence could not be verified; read the diagnostic

Details: rules · known limits · command reference · roadmap.

Development

make check              # lint, types, tests
make gate               # also build, isolated installs and self-validation
make browser-install
make report-browser OUTPUT=test-artifacts/report-browser

Archkeel checks its own architecture contract and compares fresh observations with fixtures/D-self. See CONTRIBUTING.md.

MIT © 2026 Rapiddweller Asia Co., Ltd. Maintained by Alexander Kell.

Metadata

Release files for archkeel 0.8.6

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

Source distribution (sdist)

Source distribution for archkeel 0.8.6
File Size Uploaded
archkeel-0.8.6.tar.gz 378.6 kB Details

Built distribution (wheel)

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

Total release size: 806.1 kB

Release files / archkeel-0.8.6.tar.gz

Download URL archkeel-0.8.6.tar.gz
Size 378.6 kB
Tags Source
SHA-256 checksum
How to use checksums
0506e65a4a9afa8b503f3da47be4a07cebfa467b23f3f778175c7904879d8b18
BLAKE2b-256 checksum
How to use checksums
6bfe71d57429021f5a58cbb2a73295ff117acf98f5d2d6a973e12a34a3fb4504
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.13 {"installer":{"name":"uv","version":"0.12.13","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}

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 3, 2026.

Transparency log

Release files / archkeel-0.8.6-py3-none-any.whl

Download URL archkeel-0.8.6-py3-none-any.whl
Size 427.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e94a627f3cc70635b214a45dd72b3a7c5d5f18378272571974e8663277521f98
BLAKE2b-256 checksum
How to use checksums
0c4407c62394c93cd8fdf81022e0f08f3be20c67ddc15b039785cb0f701c7584
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.13 {"installer":{"name":"uv","version":"0.12.13","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}

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 3, 2026.

Transparency log

Release history Release notifications | RSS feed

2.0.0

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.9.0

2 release files

This release

0.8.6 This release

2 release files

0.8.5

2 release files

0.8.4

2 release files

0.8.3

2 release files

0.8.2

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.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