adrlane 0.1.0__tar.gz

adrlane-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,78 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  test:
+    name: Tests on Python 3.12
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Run tests
+        run: uv run pytest --cov=adrlane
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: test
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install dependencies
+        run: uv sync --group publish
+
+      - name: Build package
+        run: uv run python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          print-hash: true
+
+  github_release:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    needs: publish
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: ${{ github.ref_name }}
+          draft: false
+          prerelease: false
+          generate_release_notes: true

adrlane-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,53 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Run ruff lint
+        run: uv run ruff check .
+
+      - name: Run ruff format check
+        run: uv run ruff format --check .
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "latest"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Run tests
+        run: uv run pytest --cov=adrlane

adrlane-0.1.0/.gitignore

@@ -0,0 +1,15 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+.eggs/
+dist/
+build/
+.venv/
+venv/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+.adrlane/

adrlane-0.1.0/.plan/config.yaml

@@ -0,0 +1,10 @@
+sync:
+  closed_issues:
+    policy: archive
+    archive_dir: .plan/archive/issues
+  github:
+    default_assignees: []
+    default_labels: []
+  behavior:
+    dry_run: false
+    verbosity: compact

adrlane-0.1.0/.plan/milestones/m1-cli-docs-bootstrap/issues/issue-001-cli-init-scaffold.md

@@ -0,0 +1,21 @@
+---
+title: Scaffold adrlane CLI with init command
+id: adrlane-m1-issue-001
+labels:
+- m1
+- cli
+milestone: 'M1: CLI and Documentation Bootstrap'
+state: open
+number: 10
+state_reason: null
+---
+
+## Goal
+
+Create the first usable CLI surface for global install and per-repository bootstrap.
+
+## Tasks
+
+- Implement package entry point and `adrlane init` command.
+- Support `--dry-run` to preview bootstrap output.
+- Ensure idempotent behavior when `init` is re-run.

adrlane-0.1.0/.plan/milestones/m1-cli-docs-bootstrap/issues/issue-002-docs-llm-contract-and-templates.md

@@ -0,0 +1,21 @@
+---
+title: Bootstrap docs structure and docs/llm contract files
+id: adrlane-m1-issue-002
+labels:
+- m1
+- docs
+milestone: 'M1: CLI and Documentation Bootstrap'
+state: open
+number: 13
+state_reason: null
+---
+
+## Goal
+
+Generate the documentation skeleton and canonical agent instructions on `init`.
+
+## Tasks
+
+- Create `docs/` folders (adr, specs, runbooks, changelog, llm).
+- Ship `docs/llm/AGENT_PROTOCOL.md`, `DECISION_RULES.md`, `TEMPLATES.md`, `DOC_GUIDELINES.md`.
+- Add starter templates for ADR, spec, runbook, and changelog entries.

adrlane-0.1.0/.plan/milestones/m1-cli-docs-bootstrap/issues/issue-003-pytest-test-foundation.md

@@ -0,0 +1,27 @@
+---
+title: Set up pytest test suite and first CLI tests
+id: adrlane-m1-issue-003
+labels:
+- m1
+- testing
+- pytest
+milestone: 'M1: CLI and Documentation Bootstrap'
+state: open
+number: 11
+state_reason: null
+---
+
+## Goal
+
+Establish pytest as the test framework and cover initial CLI and init behavior.
+
+## Tasks
+
+- Add pytest and test dependencies via uv dev group (`[dependency-groups].dev`).
+- Create `tests/` layout and fixtures for invoking the CLI in isolated temp directories.
+- Write first tests for `adrlane init` (success path, `--dry-run`, idempotent re-run).
+- Wire `pytest` into local dev workflow and document how to run tests.
+
+## Depends On
+
+- issue-001 (CLI init scaffold)

adrlane-0.1.0/.plan/milestones/m1-cli-docs-bootstrap/issues/issue-004-packaging-and-versioning.md

@@ -0,0 +1,28 @@
+---
+title: Configure Python packaging and versioning strategy
+id: adrlane-m1-issue-004
+labels:
+- m1
+- packaging
+- versioning
+milestone: 'M1: CLI and Documentation Bootstrap'
+state: open
+number: 9
+state_reason: null
+---
+
+## Goal
+
+Make `adrlane` installable as a proper Python package with a clear versioning scheme.
+
+## Tasks
+
+- Add `pyproject.toml` with PEP 621 metadata and console entry point (`adrlane`).
+- Define versioning approach (e.g. semver, single source of truth for `__version__`).
+- Configure build backend (hatchling) and verify local `uv sync` + `uv run adrlane` works.
+- Commit and maintain `uv.lock`.
+- Document global install path (`uv tool install adrlane`).
+
+## Depends On
+
+- issue-001 (CLI init scaffold)

adrlane-0.1.0/.plan/milestones/m1-cli-docs-bootstrap/issues/issue-005-ci-pipeline.md

@@ -0,0 +1,28 @@
+---
+title: Add CI pipeline for lint and pytest
+id: adrlane-m1-issue-005
+labels:
+- m1
+- ci
+- github-actions
+milestone: 'M1: CLI and Documentation Bootstrap'
+state: open
+number: 12
+state_reason: null
+---
+
+## Goal
+
+Run automated checks on every push and pull request.
+
+## Tasks
+
+- Add GitHub Actions workflow for CI.
+- Run pytest on supported Python versions.
+- Add lint/format checks (ruff or equivalent) if adopted by the project.
+- Fail CI on test or lint errors.
+
+## Depends On
+
+- issue-003 (pytest test foundation)
+- issue-004 (packaging and versioning)

adrlane-0.1.0/.plan/milestones/m1-cli-docs-bootstrap/issues/issue-006-pypi-release-workflow.md

@@ -0,0 +1,28 @@
+---
+title: Set up PyPI release workflow
+id: adrlane-m1-issue-006
+labels:
+- m1
+- pypi
+- release
+milestone: 'M1: CLI and Documentation Bootstrap'
+state: open
+number: 14
+state_reason: null
+---
+
+## Goal
+
+Publish `adrlane` to PyPI with a repeatable, versioned release process.
+
+## Tasks
+
+- Configure build and publish steps (GitHub Actions release workflow or documented manual flow).
+- Use PyPI trusted publishing or secure token-based auth.
+- Tag releases aligned with the versioning strategy from issue-004.
+- Verify `pipx install adrlane` works from PyPI after first release.
+
+## Depends On
+
+- issue-004 (packaging and versioning)
+- issue-005 (CI pipeline)

adrlane-0.1.0/.plan/milestones/m1-cli-docs-bootstrap/milestone.md

@@ -0,0 +1,34 @@
+---
+title: 'M1: CLI and Documentation Bootstrap'
+id: adrlane-m1-cli-docs-bootstrap
+description: Deliver CLI, docs bootstrap, pytest suite, packaging, CI, versioning,
+  and PyPI release workflow.
+state: open
+number: 5
+---
+
+## Scope
+
+- Build `adrlane` CLI with `init` as the primary command.
+- Scaffold `docs/` folder structure and entry templates.
+- Ship canonical `docs/llm/*` contract files for agent-agnostic documentation rules.
+- Establish pytest-based test suite for CLI and bootstrap behavior.
+- Set up Python packaging (PEP 621), versioning, CI, and PyPI publishing workflow.
+
+## Acceptance Criteria
+
+- `adrlane init` creates the full documentation tree and contract files in an empty repo.
+- Re-running `init` is idempotent and does not destroy existing documentation content.
+- Package installs globally and exposes the `adrlane` console entry point.
+- Pytest suite covers core CLI and init behavior.
+- CI runs tests on every push/PR.
+- Versioning and PyPI release process are documented and repeatable.
+
+## Issue Order
+
+1. CLI init scaffold
+2. Docs structure and `docs/llm` contract
+3. Pytest test foundation
+4. Packaging and versioning
+5. CI pipeline
+6. PyPI release workflow

adrlane-0.1.0/.plan/milestones/m2-agent-skills-adapters/issues/issue-001-cursor-skill-adapter.md

@@ -0,0 +1,22 @@
+---
+title: Implement Cursor skill adapter for documentation contract
+id: adrlane-m2-issue-001
+labels:
+- m2
+- cursor
+- skills
+milestone: 'M2: Agent Skills and Adapters'
+state: open
+number: 15
+state_reason: null
+---
+
+## Goal
+
+Give Cursor a project-local skill that points agents at the documentation system.
+
+## Tasks
+
+- Define Cursor skill format and install path.
+- Reference `docs/llm/*` as canonical rules.
+- Cover where to read context and where to write ADRs, specs, runbooks, and changelog entries.

adrlane-0.1.0/.plan/milestones/m2-agent-skills-adapters/issues/issue-002-claude-code-adapter-and-agent-flags.md

@@ -0,0 +1,22 @@
+---
+title: Implement Claude Code adapter and init --agent selection
+id: adrlane-m2-issue-002
+labels:
+- m2
+- claude-code
+- cli
+milestone: 'M2: Agent Skills and Adapters'
+state: open
+number: 16
+state_reason: null
+---
+
+## Goal
+
+Support Claude Code and let users choose which agent adapters `init` installs.
+
+## Tasks
+
+- Implement Claude Code adapter using that tool's required file layout.
+- Add repeatable `init --agent <name>` flag.
+- Ensure idempotent adapter install when `init` is re-run.

adrlane-0.1.0/.plan/milestones/m2-agent-skills-adapters/milestone.md

@@ -0,0 +1,19 @@
+---
+title: 'M2: Agent Skills and Adapters'
+id: adrlane-m2-agent-skills-adapters
+description: Install agent-specific skills that teach agents how to use the docs contract.
+state: open
+number: 6
+---
+
+## Scope
+
+- Ship Cursor and Claude Code adapters as part of `init`.
+- Keep `docs/llm/*` as canonical source; skills are concise entry points.
+- Support `init --agent` to select which adapters to install.
+
+## Acceptance Criteria
+
+- At least one supported agent adapter is installed and references `docs/llm/*`.
+- Agents can locate, read, and update documentation using the scaffolded structure.
+- Adapter install is idempotent and does not overwrite user customizations blindly.

adrlane-0.1.0/.plan/milestones/m3-polish-maintenance/issues/issue-001-doctor-informational-checks.md

@@ -0,0 +1,22 @@
+---
+title: Add informational doctor command
+id: adrlane-m3-issue-001
+labels:
+- m3
+- cli
+- doctor
+milestone: 'M3: Polish and Maintenance'
+state: open
+number: 17
+state_reason: null
+---
+
+## Goal
+
+Provide a non-blocking health check for documentation structure and agent adapters.
+
+## Tasks
+
+- Implement `adrlane doctor` as informational only.
+- Verify expected `docs/` layout and `docs/llm/*` files exist.
+- Report missing or outdated agent adapters.

adrlane-0.1.0/.plan/milestones/m3-polish-maintenance/issues/issue-002-upgrade-path-and-onboarding-docs.md

@@ -0,0 +1,22 @@
+---
+title: Define upgrade refresh strategy and onboarding documentation
+id: adrlane-m3-issue-002
+labels:
+- m3
+- docs
+- maintenance
+milestone: 'M3: Polish and Maintenance'
+state: open
+number: 18
+state_reason: null
+---
+
+## Goal
+
+Make package upgrades and first-time onboarding clear for users and agents.
+
+## Tasks
+
+- Define how `init` handles new templates/skills from upgraded `adrlane` versions.
+- Document global install (`pipx`) and per-repo `init` workflow in README.
+- Document agent workflow: agent decides when to update docs using installed skills.

adrlane-0.1.0/.plan/milestones/m3-polish-maintenance/milestone.md

@@ -0,0 +1,19 @@
+---
+title: 'M3: Polish and Maintenance'
+id: adrlane-m3-polish-maintenance
+description: Add informational doctor checks, upgrade path, and onboarding documentation.
+state: open
+number: 7
+---
+
+## Scope
+
+- Informational `doctor` command for structure and adapter presence.
+- Strategy for refreshing templates/skills on package upgrades.
+- User-facing README and onboarding docs.
+
+## Acceptance Criteria
+
+- `doctor` reports missing structure or adapters without blocking workflows.
+- Upgrade/refresh behavior is documented and predictable.
+- README explains install, init, and agent workflow end to end.

adrlane-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+  # General file checks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+        args: ['--maxkb=500']
+      - id: check-merge-conflict
+      - id: check-case-conflict
+      - id: check-json
+      - id: check-toml
+      - id: check-docstring-first
+      - id: debug-statements
+
+  # Python linting and formatting with ruff
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format

adrlane-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12