Skip to main content

Documentation-as-code bootstrap for AI agents

Project description

adrlane

Documentation-as-code bootstrap for AI agents.

adrlane init scaffolds a minimal docs/ layout and an agent-facing contract so AI tools know where to read and write project documentation. The agent decides when to update docs — there is no sync pipeline or enforcement.

Documentation model

init creates a minimal core that grows with the project:

Path Purpose
docs/specs/ What the system should do
docs/plans/ How to implement a spec
docs/adr/ Why significant decisions were made
docs/ideas/ Early concepts that may be promoted to specs
docs/roadmap/ Now / Next / Later horizons for future initiatives
docs/llm/ Agent contract and templates

Templates live in docs/llm/templates/. Documents use markdown sections (## Status, ## Related) — not YAML frontmatter.

When the project gains new documentation needs (CLI reference, runbooks, API docs), the agent adds new folders under docs/ and updates docs/README.md. init does not predict project type or scaffold empty sections.

By default, init also installs five agent skills for Cursor and Claude Code:

  • adrlane-dev-context — ambient: read specs before coding, propose ADRs after significant decisions
  • adrlane-write-idea, adrlane-write-spec, adrlane-write-plan, adrlane-write-adr — explicit documentation tasks

Use --agent cursor or --agent claude-code (repeatable) to limit which adapters are installed.

Release history stays in Git and release tooling — not in docs/.

Requirements

Development

uv sync
uv run adrlane --help
uv run adrlane init --path /path/to/target-repo
uv run adrlane init --path /path/to/target-repo --agent cursor
uv run adrlane init --path /path/to/target-repo --dry-run

Run tests:

uv run pytest

Pre-commit Hooks

This project uses pre-commit to run code quality checks before commits. Install the hooks:

uv run pre-commit install

The hooks will automatically run on git commit. They check for:

  • Code formatting and linting (ruff)
  • Trailing whitespace and end-of-file fixes
  • YAML, JSON, and TOML syntax
  • Merge conflicts and debug statements

Run hooks manually on all files:

uv run pre-commit run --all-files

Global install

uv tool install -e .
adrlane init --path /path/to/target-repo

Dependency management

uv add <package>          # runtime dependency
uv add --dev <package>    # dev dependency
uv lock                   # refresh lockfile after manual pyproject edits

License

AGPL-3.0-or-later. See LICENSE.

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

adrlane-0.2.0.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

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

adrlane-0.2.0-py3-none-any.whl (36.5 kB view details)

Uploaded Python 3

File details

Details for the file adrlane-0.2.0.tar.gz.

File metadata

  • Download URL: adrlane-0.2.0.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for adrlane-0.2.0.tar.gz
Algorithm Hash digest
SHA256 4c4737cecf5d42fad79cfd4ae03d176e07d561a3ac687daa60c9de7ca825fa39
MD5 681d7398978341f5c5c9187b99074068
BLAKE2b-256 0b62cb827159fe8d098f6b59b818ede3992bb454b0a16f014d012c32d318fbd4

See more details on using hashes here.

Provenance

The following attestation bundles were made for adrlane-0.2.0.tar.gz:

Publisher: release.yml on koradon/adrlane

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

File details

Details for the file adrlane-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: adrlane-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 36.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for adrlane-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b8f020b72713050f823c7bacb0fc657042b446ee2436cc0c81e2ab251fb1fb50
MD5 49acb6ca40097ac158632e3809584e72
BLAKE2b-256 bb797122f23b0ee46e1a706fbc0103b061c6e39e330f6c776e1426c8273a8e37

See more details on using hashes here.

Provenance

The following attestation bundles were made for adrlane-0.2.0-py3-none-any.whl:

Publisher: release.yml on koradon/adrlane

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