parsecraft 2026.9.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- parsecraft-2026.9.2/.agents/FILES.md +37 -0
- parsecraft-2026.9.2/.agents/HISTORY.md +19 -0
- parsecraft-2026.9.2/.agents/MAINTENANCE.md +37 -0
- parsecraft-2026.9.2/.agents/ONBOARDING.md +54 -0
- parsecraft-2026.9.2/.agents/POLICIES.md +127 -0
- parsecraft-2026.9.2/.beads/.gitignore +81 -0
- parsecraft-2026.9.2/.beads/README.md +85 -0
- parsecraft-2026.9.2/.beads/config.yaml +74 -0
- parsecraft-2026.9.2/.beads/hooks/post-checkout +59 -0
- parsecraft-2026.9.2/.beads/hooks/post-merge +59 -0
- parsecraft-2026.9.2/.beads/hooks/pre-commit +59 -0
- parsecraft-2026.9.2/.beads/hooks/pre-push +59 -0
- parsecraft-2026.9.2/.beads/hooks/prepare-commit-msg +59 -0
- parsecraft-2026.9.2/.beads/metadata.json +7 -0
- parsecraft-2026.9.2/.config/csort.toml +49 -0
- parsecraft-2026.9.2/.config/mise/conf.d/docs.toml +7 -0
- parsecraft-2026.9.2/.config/mise/conf.d/format.toml +11 -0
- parsecraft-2026.9.2/.config/mise/conf.d/lint.toml +11 -0
- parsecraft-2026.9.2/.config/mise/conf.d/mcp.toml +8 -0
- parsecraft-2026.9.2/.config/mise/conf.d/quality.toml +23 -0
- parsecraft-2026.9.2/.config/mise/conf.d/skills.toml +5 -0
- parsecraft-2026.9.2/.config/mise/conf.d/tasks.toml +3 -0
- parsecraft-2026.9.2/.config/mise/config.toml +38 -0
- parsecraft-2026.9.2/.config/mise/data/dev-features.csv +19 -0
- parsecraft-2026.9.2/.config/mise/data/skills.csv +16 -0
- parsecraft-2026.9.2/.config/mise/scripts/install_dev_features.py +94 -0
- parsecraft-2026.9.2/.config/rumdl.toml +62 -0
- parsecraft-2026.9.2/.gitattributes +32 -0
- parsecraft-2026.9.2/.github/workflows/ci.yml +157 -0
- parsecraft-2026.9.2/.github/workflows/release.yml +184 -0
- parsecraft-2026.9.2/.gitignore +82 -0
- parsecraft-2026.9.2/.pre-commit-config.yaml +33 -0
- parsecraft-2026.9.2/AGENTS.md +141 -0
- parsecraft-2026.9.2/LICENSE +21 -0
- parsecraft-2026.9.2/PKG-INFO +196 -0
- parsecraft-2026.9.2/README.md +173 -0
- parsecraft-2026.9.2/docs/AGENTS.md +72 -0
- parsecraft-2026.9.2/docs/adr/0001-phase-0-decisions.md +273 -0
- parsecraft-2026.9.2/docs/adr/0002-release-and-distribution.md +66 -0
- parsecraft-2026.9.2/docs/architecture/backends.md +96 -0
- parsecraft-2026.9.2/docs/architecture/ir.md +96 -0
- parsecraft-2026.9.2/docs/architecture/overview.md +71 -0
- parsecraft-2026.9.2/docs/code_of_conduct.md +43 -0
- parsecraft-2026.9.2/docs/contributing.md +44 -0
- parsecraft-2026.9.2/docs/credits.md +9 -0
- parsecraft-2026.9.2/docs/getting-started/installation.md +74 -0
- parsecraft-2026.9.2/docs/getting-started/quickstart.md +75 -0
- parsecraft-2026.9.2/docs/getting-started/quickstart.py +48 -0
- parsecraft-2026.9.2/docs/guides/backend-authoring.md +170 -0
- parsecraft-2026.9.2/docs/index.md +24 -0
- parsecraft-2026.9.2/docs/license.md +11 -0
- parsecraft-2026.9.2/docs/reference/api.md +22 -0
- parsecraft-2026.9.2/docs/reference/cli.md +169 -0
- parsecraft-2026.9.2/examples/third_party_backend/pyproject.toml +17 -0
- parsecraft-2026.9.2/examples/third_party_backend/src/parsecraft_example_backend/__init__.py +43 -0
- parsecraft-2026.9.2/examples/third_party_backend/src/parsecraft_example_backend/impl.py +78 -0
- parsecraft-2026.9.2/pyproject.toml +82 -0
- parsecraft-2026.9.2/ruff.toml +76 -0
- parsecraft-2026.9.2/scripts/gen_credits.py +34 -0
- parsecraft-2026.9.2/src/parsecraft/AGENTS.md +45 -0
- parsecraft-2026.9.2/src/parsecraft/__about__.py +22 -0
- parsecraft-2026.9.2/src/parsecraft/__init__.py +10 -0
- parsecraft-2026.9.2/src/parsecraft/__main__.py +8 -0
- parsecraft-2026.9.2/src/parsecraft/adapters/AGENTS.md +35 -0
- parsecraft-2026.9.2/src/parsecraft/adapters/__init__.py +11 -0
- parsecraft-2026.9.2/src/parsecraft/adapters/markdown.py +271 -0
- parsecraft-2026.9.2/src/parsecraft/assets/AGENTS.md +37 -0
- parsecraft-2026.9.2/src/parsecraft/assets/__init__.py +44 -0
- parsecraft-2026.9.2/src/parsecraft/assets/downloader.py +35 -0
- parsecraft-2026.9.2/src/parsecraft/assets/errors.py +48 -0
- parsecraft-2026.9.2/src/parsecraft/assets/huggingface.py +23 -0
- parsecraft-2026.9.2/src/parsecraft/assets/manager.py +242 -0
- parsecraft-2026.9.2/src/parsecraft/assets/models.py +59 -0
- parsecraft-2026.9.2/src/parsecraft/backends/AGENTS.md +45 -0
- parsecraft-2026.9.2/src/parsecraft/backends/__init__.py +47 -0
- parsecraft-2026.9.2/src/parsecraft/backends/errors.py +38 -0
- parsecraft-2026.9.2/src/parsecraft/backends/protocol.py +175 -0
- parsecraft-2026.9.2/src/parsecraft/backends/registry.py +107 -0
- parsecraft-2026.9.2/src/parsecraft/cli/__init__.py +3 -0
- parsecraft-2026.9.2/src/parsecraft/cli/app.py +65 -0
- parsecraft-2026.9.2/src/parsecraft/cli/args.py +31 -0
- parsecraft-2026.9.2/src/parsecraft/cli/commands.py +83 -0
- parsecraft-2026.9.2/src/parsecraft/cli/config.py +131 -0
- parsecraft-2026.9.2/src/parsecraft/config/AGENTS.md +53 -0
- parsecraft-2026.9.2/src/parsecraft/config/__init__.py +41 -0
- parsecraft-2026.9.2/src/parsecraft/config/engine.py +399 -0
- parsecraft-2026.9.2/src/parsecraft/config/errors.py +44 -0
- parsecraft-2026.9.2/src/parsecraft/config/models.py +87 -0
- parsecraft-2026.9.2/src/parsecraft/ir/AGENTS.md +40 -0
- parsecraft-2026.9.2/src/parsecraft/ir/__init__.py +63 -0
- parsecraft-2026.9.2/src/parsecraft/ir/markdown.py +91 -0
- parsecraft-2026.9.2/src/parsecraft/ir/models.py +354 -0
- parsecraft-2026.9.2/src/parsecraft/py.typed +0 -0
- parsecraft-2026.9.2/tests/AGENTS.md +54 -0
- parsecraft-2026.9.2/tests/__init__.py +1 -0
- parsecraft-2026.9.2/tests/conftest.py +90 -0
- parsecraft-2026.9.2/tests/fixtures/__init__.py +1 -0
- parsecraft-2026.9.2/tests/fixtures/documents.py +173 -0
- parsecraft-2026.9.2/tests/fixtures/sources.py +116 -0
- parsecraft-2026.9.2/tests/fixtures/sources.toml +166 -0
- parsecraft-2026.9.2/tests/test_adapters_markdown.py +274 -0
- parsecraft-2026.9.2/tests/test_assets.py +357 -0
- parsecraft-2026.9.2/tests/test_backends_registry.py +374 -0
- parsecraft-2026.9.2/tests/test_cli_config.py +206 -0
- parsecraft-2026.9.2/tests/test_config.py +314 -0
- parsecraft-2026.9.2/tests/test_document_fixtures.py +202 -0
- parsecraft-2026.9.2/tests/test_example_backend.py +112 -0
- parsecraft-2026.9.2/tests/test_ir.py +518 -0
- parsecraft-2026.9.2/tests/test_markdown_projection.py +223 -0
- parsecraft-2026.9.2/tests/test_offline_import.py +59 -0
- parsecraft-2026.9.2/tests/test_packaging.py +77 -0
- parsecraft-2026.9.2/tests/test_smoke.py +261 -0
- parsecraft-2026.9.2/tests/test_sources_manifest.py +272 -0
- parsecraft-2026.9.2/tests/test_template_validation.py +98 -0
- parsecraft-2026.9.2/tests/typing_consumer.py +62 -0
- parsecraft-2026.9.2/ty.toml +13 -0
- parsecraft-2026.9.2/zensical.toml +184 -0
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# AGENTS.md — FILES
|
|
2
|
+
|
|
3
|
+
Single source of truth for paths, config keys, and naming conventions.
|
|
4
|
+
Kept compact — agents hallucinate less when they know where definitions live.
|
|
5
|
+
|
|
6
|
+
## Pattern
|
|
7
|
+
|
|
8
|
+
- One file owns each class of definition (paths, config defaults, enums).
|
|
9
|
+
- Import from that file. Never hard-code values in other modules.
|
|
10
|
+
- Variables that address files get `_file` suffix; directories get `_dir`.
|
|
11
|
+
|
|
12
|
+
## Project-specific sources of truth
|
|
13
|
+
|
|
14
|
+
| What | Where | Key names |
|
|
15
|
+
| ---------------------- | --------------------------------------------------------------- | ----------------------------------------------- |
|
|
16
|
+
| Package source root | `src/parsecraft/` | `__init__.py`, `__about__.py` (version) |
|
|
17
|
+
| CLI entry points | `src/parsecraft/cli/` | `app.py` (Typer app), `args.py`, `commands.py` |
|
|
18
|
+
| Test suite | `tests/` | `test_*.py`, `conftest.py` |
|
|
19
|
+
| Issue tracker (beads) | `.beads/` | `bd` CLI, issue prefix `pc` |
|
|
20
|
+
| Project metadata | `pyproject.toml` | `[project]`, `[tool.pytest.ini_options]` |
|
|
21
|
+
| Linter/formatter | `ruff.toml` | Ruff rule selection, line length |
|
|
22
|
+
| Type checker | `ty.toml` | ty strictness |
|
|
23
|
+
| Markdown linter | `.config/rumdl.toml` | `line-length`, `flavor`, disabled rules |
|
|
24
|
+
| mise tasks | `.config/mise/config.toml` + `.config/mise/conf.d/*.toml` | `[tasks.dev]`, `[tasks.test]`, ... |
|
|
25
|
+
| Copier answers | `.copier-answers.yml` | Template version + answers (regenerated) |
|
|
26
|
+
| Pre-commit config | `.pre-commit-config.yaml` | Hook list |
|
|
27
|
+
| MCP server config | `.config/mise/conf.d/mcp.toml` | `[tasks.add-mcp-servers]`, tool list |
|
|
28
|
+
| Skills install task | `.config/mise/conf.d/skills.toml` | `[tasks.add-skills]`, skill list |
|
|
29
|
+
|
|
30
|
+
## Naming conventions
|
|
31
|
+
|
|
32
|
+
- **Repository name** (`project_slug`): kebab-case (`my-project`)
|
|
33
|
+
- **Python package** (`package_slug`): snake_case (`my_project`)
|
|
34
|
+
- **Layout**: `src/parsecraft/`
|
|
35
|
+
- **Test files**: `test_<module>.py`
|
|
36
|
+
- **Template files** (in source template): `filename.ext.jinja` — the `.jinja`
|
|
37
|
+
suffix is stripped on generation
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# AGENTS.md — HISTORY
|
|
2
|
+
|
|
3
|
+
Recorded decisions with git references. Read when relevant to current task.
|
|
4
|
+
Acts as simple long-term memory for the project.
|
|
5
|
+
|
|
6
|
+
## Format
|
|
7
|
+
|
|
8
|
+
| Date | Decision | Rationale | Git ref |
|
|
9
|
+
| ---------- | ---------- | ----------- | ---------------- |
|
|
10
|
+
| YYYY-MM-DD | [describe] | [why] | [commit hash/tag] |
|
|
11
|
+
|
|
12
|
+
## Guidance
|
|
13
|
+
|
|
14
|
+
- Record decisions that would be costly to rediscover.
|
|
15
|
+
- Note false turns and why they were rejected.
|
|
16
|
+
- Link to relevant commits.
|
|
17
|
+
- Keep entries brief — enough to reconstruct reasoning.
|
|
18
|
+
- When this file grows too large, archive older entries to
|
|
19
|
+
`.agents/history/` and leave a pointer here.
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# AGENTS.md — MAINTENANCE
|
|
2
|
+
|
|
3
|
+
How to keep `.agents/` files current.
|
|
4
|
+
|
|
5
|
+
## Process
|
|
6
|
+
|
|
7
|
+
1. When a rule changes, update the owning file — never another file.
|
|
8
|
+
2. When adding a new `.agents/` file or directory, add it to the index table
|
|
9
|
+
in root `AGENTS.md`.
|
|
10
|
+
3. After any `.agents/` change, check the index for stale entries.
|
|
11
|
+
4. Check for tool-injected patches in `AGENTS.md` — anything after the
|
|
12
|
+
`⛔ No Patching` marker is invalid. If a tool has a legitimate rule,
|
|
13
|
+
integrate it into the `Project rules` section above the marker; never
|
|
14
|
+
append below it.
|
|
15
|
+
|
|
16
|
+
## Principles
|
|
17
|
+
|
|
18
|
+
- **Single source of truth.** Each rule lives in exactly one file. The tier,
|
|
19
|
+
pointer, rationale, and size rules are in **DOX authoring**
|
|
20
|
+
(`.agents/POLICIES.md`) — consult it on every DOX change.
|
|
21
|
+
- **AGENTS.md is an index.** It points to `.agents/` files, does not replace
|
|
22
|
+
them.
|
|
23
|
+
- **No Patching is a gate, not a target.** Tools that try to append to
|
|
24
|
+
`AGENTS.md` are blocked by the `⛔ No Patching` marker. Legitimate
|
|
25
|
+
instructions must be curated into `Project rules`, not appended blindly.
|
|
26
|
+
|
|
27
|
+
## File update triggers
|
|
28
|
+
|
|
29
|
+
| File / Dir | Update when |
|
|
30
|
+
| -------------- | ---------------------------------------------------------------------- |
|
|
31
|
+
| `ONBOARDING.md` | Project structure, tooling, or entry points change |
|
|
32
|
+
| `POLICIES.md` | Boundaries, priorities, or verification change |
|
|
33
|
+
| `FILES.md` | Path constants, config keys, or naming conventions change |
|
|
34
|
+
| `HISTORY.md` | Notable decision made or resolved |
|
|
35
|
+
| `MAINTENANCE.md` | Maintenance procedures, triggers, or principles change |
|
|
36
|
+
| `plans/` | New feature implementation starts |
|
|
37
|
+
| `history/` | HISTORY.md overflow or completed plans archived |
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# AGENTS.md — ONBOARDING
|
|
2
|
+
|
|
3
|
+
Read this when starting a new session. After first read, only revisit when
|
|
4
|
+
project structure or tooling changes significantly.
|
|
5
|
+
|
|
6
|
+
## Project
|
|
7
|
+
|
|
8
|
+
Document intelligence: convert any document into typed structured chunks, with Markdown as a deterministic projection Full docs at `README.md` or `docs/`.
|
|
9
|
+
|
|
10
|
+
## Quick start
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
mise dev # install dependencies (uv sync --dev)
|
|
14
|
+
mise test # run pytest with coverage
|
|
15
|
+
mise lint # ruff + ty + codespell
|
|
16
|
+
mise format # ruff format + isort + clean-sort
|
|
17
|
+
mise all # test + lint + format in one pass
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Entry points (read these first)
|
|
21
|
+
|
|
22
|
+
| File / Section | Why |
|
|
23
|
+
| -------------- | --- |
|
|
24
|
+
| `AGENTS.md` | Root rail — rules + `.agents/` index |
|
|
25
|
+
| `.agents/POLICIES.md` | Boundaries, priorities, verification |
|
|
26
|
+
| `.agents/FILES.md` | Source-of-truth locations for this package |
|
|
27
|
+
| `pyproject.toml` | Dependencies, pytest config, build backend |
|
|
28
|
+
| `.copier-answers.yml` | Template answers (regenerated on `copier update`) |
|
|
29
|
+
|
|
30
|
+
## Layout
|
|
31
|
+
|
|
32
|
+
- **`src/parsecraft/`** — primary package source (src layout)
|
|
33
|
+
- **`tests/`** — pytest suite (100% coverage gate)
|
|
34
|
+
- **`src/parsecraft/cli/`** — Typer CLI
|
|
35
|
+
- **`docs/`** — Zensical / MkDocs Material documentation
|
|
36
|
+
- **`.config/mise/`** — task runner config (`config.toml` + `conf.d/` fragments)
|
|
37
|
+
|
|
38
|
+
## Where to dig deeper
|
|
39
|
+
|
|
40
|
+
- `docs/` — user-facing documentation
|
|
41
|
+
- `.agents/HISTORY.md` — past decisions and rationale
|
|
42
|
+
- Source-tree AGENTS.md files — local contracts for each area
|
|
43
|
+
|
|
44
|
+
## Available tools
|
|
45
|
+
|
|
46
|
+
If MCP dev-features are enabled (`include_mcp_tasks`), the following may be
|
|
47
|
+
available after running `mise run add-mcp-servers <agent>` and `mise run
|
|
48
|
+
add-skills`:
|
|
49
|
+
|
|
50
|
+
- **repowise** — architecture overview, risk, health scores, change-risk
|
|
51
|
+
- **codegraph** — symbol search, call graphs, dependency maps
|
|
52
|
+
- **grepai** — semantic code search by meaning, not text
|
|
53
|
+
- **bd / beads** — distributed issue tracker (if `tracking` skill category enabled)
|
|
54
|
+
- Various slop/dead-code detectors (see `.config/mise/conf.d/skills.toml`)
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
# AGENTS.md — POLICIES
|
|
2
|
+
|
|
3
|
+
Always applicable. Boundaries, priorities, verification, checklist.
|
|
4
|
+
|
|
5
|
+
## Priorities
|
|
6
|
+
|
|
7
|
+
1. Correctness
|
|
8
|
+
2. Evidence
|
|
9
|
+
3. Safety
|
|
10
|
+
4. Minimal changes
|
|
11
|
+
5. Consistency
|
|
12
|
+
6. Performance
|
|
13
|
+
|
|
14
|
+
## Boundaries
|
|
15
|
+
|
|
16
|
+
- NEVER fabricate paths, commits, APIs, config keys, env vars, test results,
|
|
17
|
+
or benchmark numbers. If you don't know, say so.
|
|
18
|
+
- NEVER guess at command names, flags, or paths. Read source or run `--help`.
|
|
19
|
+
- NEVER add secrets, API keys, or tokens to files. Use env vars.
|
|
20
|
+
- NEVER run destructive commands (`rm -rf`, `git reset --hard`,
|
|
21
|
+
`git push --force`) without explicit confirmation.
|
|
22
|
+
- NEVER delete or move files without explicit instruction.
|
|
23
|
+
- NEVER create temp files in project root. Use dedicated temp dir.
|
|
24
|
+
|
|
25
|
+
## Change constraints
|
|
26
|
+
|
|
27
|
+
- Minimal, surgical edits. Preserve existing style.
|
|
28
|
+
- No new dependencies without explicit instruction.
|
|
29
|
+
- No unrelated refactoring while fixing a bug.
|
|
30
|
+
|
|
31
|
+
## Code quality
|
|
32
|
+
|
|
33
|
+
Universal defaults. Project-specific standards live in child AGENTS.md.
|
|
34
|
+
|
|
35
|
+
- **SRP** — one reason to change per module/function.
|
|
36
|
+
- **DRY** — check before adding. Extract on third occurrence (Rule of Three).
|
|
37
|
+
- **Redundant code** — remove dead branches, unreachable conditions, unused
|
|
38
|
+
params/imports before finishing.
|
|
39
|
+
- **Duplication vs. abstraction** — prefer duplication over wrong premature
|
|
40
|
+
abstraction.
|
|
41
|
+
- No new code-quality tooling by default — opt in per project.
|
|
42
|
+
|
|
43
|
+
## Completion checklist
|
|
44
|
+
|
|
45
|
+
- Change solves the stated problem
|
|
46
|
+
- Relevant validation ran (or gaps stated)
|
|
47
|
+
- No unintended side effects or secrets exposed
|
|
48
|
+
|
|
49
|
+
## DOX authoring (keep AGENTS.md lean)
|
|
50
|
+
|
|
51
|
+
AGENTS.md and `.agents/` files share limited context. Bloat and duplication
|
|
52
|
+
are the failure mode.
|
|
53
|
+
|
|
54
|
+
### Where a rule lives
|
|
55
|
+
|
|
56
|
+
A rule goes in the **highest (most general) tier that fully applies**:
|
|
57
|
+
|
|
58
|
+
- Applies to **all code in the project** → `.agents/POLICIES.md` (default).
|
|
59
|
+
- Meaningful **only inside one subtree** → that subtree's `AGENTS.md`.
|
|
60
|
+
- Just helps navigation → the parent's Child DOX Index, nothing else.
|
|
61
|
+
|
|
62
|
+
### Reference, don't restate
|
|
63
|
+
|
|
64
|
+
A rule appears in **exactly one file**. Other files use a **pointer line**:
|
|
65
|
+
`<topic> — see <file>`. Never copy the rule, rationale, or example.
|
|
66
|
+
|
|
67
|
+
### Rule first, rationale second, never third
|
|
68
|
+
|
|
69
|
+
A DOX line is the rule. If a rationale is costly to rediscover, add one
|
|
70
|
+
short clause. No multi-paragraph explanations or code pairs — those belong
|
|
71
|
+
in a skill or `docs/`, linked once.
|
|
72
|
+
|
|
73
|
+
### Content rules
|
|
74
|
+
|
|
75
|
+
- **No tree views.** Generate on demand with `rg --files | tree-cli --fromfile`.
|
|
76
|
+
- **No history in AGENTS.md files.** Git log has routine history. Record only
|
|
77
|
+
decisions costly to rediscover — in `.agents/HISTORY.md` (or
|
|
78
|
+
`.agents/history/` for overflow archives). See **Implementation Plans**
|
|
79
|
+
below for archiving completed plans.
|
|
80
|
+
- **No TODO lists.** Use issue trackers or beads.
|
|
81
|
+
|
|
82
|
+
## Implementation Plans
|
|
83
|
+
|
|
84
|
+
- Plans, refactoring plans, and design docs go in `.agents/plans/<feature>/`
|
|
85
|
+
— NOT under version control (gitignored).
|
|
86
|
+
- Name descriptively with phase-number prefixes so file order matches
|
|
87
|
+
implementation order, e.g. `01-sub-feature.md`, `02-next-sub-feature.md`.
|
|
88
|
+
- NEVER commit plans to git. They are mutable working artifacts.
|
|
89
|
+
- Shipped docs (user-facing guides, API references) go in `docs/` and
|
|
90
|
+
ARE committed.
|
|
91
|
+
|
|
92
|
+
## Documentation
|
|
93
|
+
|
|
94
|
+
- When `.agents/HISTORY.md` grows too large, archive older entries to
|
|
95
|
+
`.agents/history/`. Reference them from `.agents/HISTORY.md`.
|
|
96
|
+
- Completed plans (`.agents/plans/<feature>/`) may be archived to
|
|
97
|
+
`.agents/history/<feature>/` for long-term reference.
|
|
98
|
+
- `.agents/history/` IS version-controlled (durable decision records).
|
|
99
|
+
|
|
100
|
+
## Size budget
|
|
101
|
+
|
|
102
|
+
- `.agents/` files: ≤ **120 lines** (always-injected context).
|
|
103
|
+
- Subtree `AGENTS.md`: ≤ **250 lines** (loaded cumulatively with parents).
|
|
104
|
+
|
|
105
|
+
Exceeding the budget signals restating instead of pointing, or hoarding
|
|
106
|
+
rationale. Cut first; split the subtree only as a last resort.
|
|
107
|
+
|
|
108
|
+
## Verification
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
mise all # test + lint + format (composite task)
|
|
112
|
+
mise test # pytest with coverage gate (100%)
|
|
113
|
+
mise lint # ruff + ty + codespell
|
|
114
|
+
mise format # ruff format + isort + clean-sort
|
|
115
|
+
mise format-md # rumdl over docs/, .agents/, ./ (Markdown only)
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
Pre-commit hooks (`.pre-commit-config.yaml`) run a subset of the above on every
|
|
119
|
+
commit. Run `pre-commit run --all-files` to check the whole tree.
|
|
120
|
+
|
|
121
|
+
## Response format
|
|
122
|
+
|
|
123
|
+
Concise and specific. No filler, intros, or restated requirements.
|
|
124
|
+
Answer direct questions directly.
|
|
125
|
+
|
|
126
|
+
For review/debugging/analysis: findings with references, conclusion,
|
|
127
|
+
approach. Mention caveats.
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# Dolt database (managed by Dolt, not git)
|
|
2
|
+
dolt/
|
|
3
|
+
embeddeddolt/
|
|
4
|
+
proxieddb/
|
|
5
|
+
|
|
6
|
+
# Runtime files
|
|
7
|
+
bd.sock
|
|
8
|
+
bd.sock.startlock
|
|
9
|
+
sync-state.json
|
|
10
|
+
last-touched
|
|
11
|
+
.exclusive-lock
|
|
12
|
+
|
|
13
|
+
# Daemon runtime (lock, log, pid)
|
|
14
|
+
daemon.*
|
|
15
|
+
|
|
16
|
+
# Push state (runtime, per-machine)
|
|
17
|
+
push-state.json
|
|
18
|
+
|
|
19
|
+
# Lock files (various runtime locks)
|
|
20
|
+
*.lock
|
|
21
|
+
|
|
22
|
+
# Credential key (encryption key for federation peer auth — never commit)
|
|
23
|
+
.beads-credential-key
|
|
24
|
+
|
|
25
|
+
# Local version tracking (prevents upgrade notification spam after git ops)
|
|
26
|
+
.local_version
|
|
27
|
+
|
|
28
|
+
proxied_server_client_info.json
|
|
29
|
+
|
|
30
|
+
# Worktree redirect file (contains relative path to main repo's .beads/)
|
|
31
|
+
# Must not be committed as paths would be wrong in other clones
|
|
32
|
+
redirect
|
|
33
|
+
|
|
34
|
+
# Sync state (local-only, per-machine)
|
|
35
|
+
# These files are machine-specific and should not be shared across clones
|
|
36
|
+
.sync.lock
|
|
37
|
+
|
|
38
|
+
# Workspace operation gate (internal/workspacegate): physical-root gate
|
|
39
|
+
# files live beside the guarded root inside .beads (e.g. dolt.gate.lock)
|
|
40
|
+
*.gate.lock*
|
|
41
|
+
export-state/
|
|
42
|
+
export-state.json
|
|
43
|
+
last_pull
|
|
44
|
+
|
|
45
|
+
# Ephemeral store (SQLite - wisps/molecules, intentionally not versioned)
|
|
46
|
+
ephemeral.sqlite3
|
|
47
|
+
ephemeral.sqlite3-journal
|
|
48
|
+
ephemeral.sqlite3-wal
|
|
49
|
+
ephemeral.sqlite3-shm
|
|
50
|
+
|
|
51
|
+
# Dolt server management (auto-started by bd)
|
|
52
|
+
dolt-server.pid
|
|
53
|
+
dolt-server.log
|
|
54
|
+
dolt-server.lock
|
|
55
|
+
dolt-server.port
|
|
56
|
+
dolt-server.activity
|
|
57
|
+
|
|
58
|
+
# Debug-mode pprof artifacts (written when dolt.debug: true in config.yaml)
|
|
59
|
+
dolt-pprof/
|
|
60
|
+
|
|
61
|
+
# Corrupt backup directories (created by bd doctor --fix recovery)
|
|
62
|
+
*.corrupt.backup/
|
|
63
|
+
|
|
64
|
+
# Backup data (auto-exported JSONL, local-only)
|
|
65
|
+
backup/
|
|
66
|
+
|
|
67
|
+
# Per-project environment file (Dolt connection config, GH#2520)
|
|
68
|
+
.env
|
|
69
|
+
|
|
70
|
+
# Legacy files (from pre-Dolt versions)
|
|
71
|
+
*.db
|
|
72
|
+
*.db?*
|
|
73
|
+
*.db-journal
|
|
74
|
+
*.db-wal
|
|
75
|
+
*.db-shm
|
|
76
|
+
db.sqlite
|
|
77
|
+
bd.db
|
|
78
|
+
# NOTE: Do NOT add negation patterns here.
|
|
79
|
+
# They would override fork protection in .git/info/exclude.
|
|
80
|
+
# Config files (metadata.json, config.yaml) are tracked by git by default
|
|
81
|
+
# since no pattern above ignores them.
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# Beads - AI-Native Issue Tracking
|
|
2
|
+
|
|
3
|
+
Welcome to Beads! This repository uses **Beads** for issue tracking - a modern, AI-native tool designed to live directly in your codebase alongside your code.
|
|
4
|
+
|
|
5
|
+
## What is Beads?
|
|
6
|
+
|
|
7
|
+
Beads is issue tracking that lives in your repo, making it perfect for AI coding agents and developers who want their issues close to their code. No web UI required - everything works through the CLI and integrates seamlessly with git.
|
|
8
|
+
|
|
9
|
+
**Learn more:** [github.com/steveyegge/beads](https://github.com/steveyegge/beads)
|
|
10
|
+
|
|
11
|
+
## Quick Start
|
|
12
|
+
|
|
13
|
+
### Essential Commands
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# Create new issues
|
|
17
|
+
bd create "Add user authentication"
|
|
18
|
+
|
|
19
|
+
# View all issues
|
|
20
|
+
bd list
|
|
21
|
+
|
|
22
|
+
# View issue details
|
|
23
|
+
bd show <issue-id>
|
|
24
|
+
|
|
25
|
+
# Update issue status
|
|
26
|
+
bd update <issue-id> --claim
|
|
27
|
+
bd update <issue-id> --status done
|
|
28
|
+
|
|
29
|
+
# Sync with Dolt remote
|
|
30
|
+
bd dolt push
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Working with Issues
|
|
34
|
+
|
|
35
|
+
Issues in Beads are:
|
|
36
|
+
|
|
37
|
+
- **Git-native**: Stored in Dolt database with version control and branching
|
|
38
|
+
- **AI-friendly**: CLI-first design works perfectly with AI coding agents
|
|
39
|
+
- **Branch-aware**: Issues can follow your branch workflow
|
|
40
|
+
- **Sync-ready**: Uses Dolt remotes for backup and team sharing
|
|
41
|
+
|
|
42
|
+
## Why Beads?
|
|
43
|
+
|
|
44
|
+
✨ **AI-Native Design**
|
|
45
|
+
|
|
46
|
+
- Built specifically for AI-assisted development workflows
|
|
47
|
+
- CLI-first interface works seamlessly with AI coding agents
|
|
48
|
+
- No context switching to web UIs
|
|
49
|
+
|
|
50
|
+
🚀 **Developer Focused**
|
|
51
|
+
|
|
52
|
+
- Issues live in your repo, right next to your code
|
|
53
|
+
- Works offline, syncs when you push
|
|
54
|
+
- Fast, lightweight, and stays out of your way
|
|
55
|
+
|
|
56
|
+
🔧 **Git Integration**
|
|
57
|
+
|
|
58
|
+
- Dolt-native sync via bd dolt push / bd dolt pull
|
|
59
|
+
- Branch-aware issue tracking
|
|
60
|
+
- Dolt-native three-way merge resolution
|
|
61
|
+
|
|
62
|
+
## Get Started with Beads
|
|
63
|
+
|
|
64
|
+
Try Beads in your own projects:
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
# Install Beads
|
|
68
|
+
curl -sSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/install.sh | bash
|
|
69
|
+
|
|
70
|
+
# Initialize in your repo
|
|
71
|
+
bd init
|
|
72
|
+
|
|
73
|
+
# Create your first issue
|
|
74
|
+
bd create "Try out Beads"
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## Learn More
|
|
78
|
+
|
|
79
|
+
- **Documentation**: [github.com/steveyegge/beads/docs](https://github.com/steveyegge/beads/tree/main/docs)
|
|
80
|
+
- **Quick Start Guide**: Run `bd quickstart`
|
|
81
|
+
- **Examples**: [github.com/steveyegge/beads/examples](https://github.com/steveyegge/beads/tree/main/examples)
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
*Beads: Issue tracking that moves at the speed of thought* ⚡
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# Beads Configuration File
|
|
2
|
+
# This file configures default behavior for all bd commands in this repository
|
|
3
|
+
# All settings can also be set via environment variables (BD_* prefix)
|
|
4
|
+
# or overridden with command-line flags
|
|
5
|
+
|
|
6
|
+
# Issue prefix for this repository (used by bd init)
|
|
7
|
+
# If not set, bd init will auto-detect from directory name
|
|
8
|
+
# Example: issue-prefix: "myproject" creates issues like "myproject-1", "myproject-2", etc.
|
|
9
|
+
# issue-prefix: ""
|
|
10
|
+
|
|
11
|
+
# Use no-db mode: JSONL-only, no Dolt database
|
|
12
|
+
# When true, .beads/issues.jsonl is the only local store
|
|
13
|
+
# no-db: false
|
|
14
|
+
|
|
15
|
+
# Enable JSON output by default
|
|
16
|
+
# json: false
|
|
17
|
+
|
|
18
|
+
# Feedback title formatting for mutating commands (create/update/close/dep/edit)
|
|
19
|
+
# 0 = hide titles, N > 0 = truncate to N characters
|
|
20
|
+
# output:
|
|
21
|
+
# title-length: 255
|
|
22
|
+
|
|
23
|
+
# Default actor for audit trails (overridden by BEADS_ACTOR or --actor)
|
|
24
|
+
# actor: ""
|
|
25
|
+
|
|
26
|
+
# Optional JSONL sidecar for explicit agent/tool interaction audit records.
|
|
27
|
+
# Issue history is always recorded in the database and is visible with
|
|
28
|
+
# bd history <id> --events; this only controls .beads/interactions.jsonl.
|
|
29
|
+
# audit:
|
|
30
|
+
# enabled: false
|
|
31
|
+
|
|
32
|
+
# Export events (audit trail) to .beads/events.jsonl on each flush/sync
|
|
33
|
+
# When enabled, new events are appended incrementally using a high-water mark.
|
|
34
|
+
# Use 'bd export --events' to trigger manually regardless of this setting.
|
|
35
|
+
# events-export: false
|
|
36
|
+
|
|
37
|
+
# Multi-repo configuration (experimental - bd-307)
|
|
38
|
+
# Allows hydrating from multiple repositories and routing writes to the correct database
|
|
39
|
+
# repos:
|
|
40
|
+
# primary: "." # Primary repo (where this database lives)
|
|
41
|
+
# additional: # Additional repos to hydrate from (read-only)
|
|
42
|
+
# - ~/beads-planning # Personal planning repo
|
|
43
|
+
# - ~/work-planning # Work planning repo
|
|
44
|
+
|
|
45
|
+
# Dolt-native backup (periodic backup for off-machine recovery)
|
|
46
|
+
# This is full database backup only. Cross-machine sync uses Dolt remotes.
|
|
47
|
+
# backup:
|
|
48
|
+
# enabled: false # Disable auto-backup entirely
|
|
49
|
+
# interval: 15m # Minimum time between auto-backups
|
|
50
|
+
# git-push: false # Disable git push (backup locally only)
|
|
51
|
+
# git-repo: "" # Separate git repo for backups (default: project repo)
|
|
52
|
+
|
|
53
|
+
# Optional JSONL auto-export for viewers, interchange, and issue-level migration.
|
|
54
|
+
# Disabled by default; enable only when an integration needs fresh .beads/issues.jsonl.
|
|
55
|
+
# Use relative paths under .beads/ for JSONL import/export filenames.
|
|
56
|
+
# export:
|
|
57
|
+
# auto: false
|
|
58
|
+
# path: issues.jsonl
|
|
59
|
+
# interval: 60s
|
|
60
|
+
# git-add: false
|
|
61
|
+
# import:
|
|
62
|
+
# path: issues.jsonl
|
|
63
|
+
|
|
64
|
+
# Integration settings (access with 'bd config get/set')
|
|
65
|
+
# Non-secret keys (stored in the database):
|
|
66
|
+
# - jira.url, jira.project
|
|
67
|
+
# - linear.team_id
|
|
68
|
+
# - github.org, github.repo
|
|
69
|
+
#
|
|
70
|
+
# Secret keys (stored in this file but prefer env vars to avoid git exposure):
|
|
71
|
+
# - linear.api_key → use LINEAR_API_KEY env var instead
|
|
72
|
+
# - github.token → use GITHUB_TOKEN env var instead
|
|
73
|
+
|
|
74
|
+
sync.remote: "git+https://github.com/jr2804/parsecraft.git"
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
#!/usr/bin/env sh
|
|
2
|
+
# --- BEGIN BEADS INTEGRATION v1.3.0 ---
|
|
3
|
+
# This section is managed by beads. Do not remove these markers.
|
|
4
|
+
if command -v bd >/dev/null 2>&1; then
|
|
5
|
+
export BD_GIT_HOOK=1
|
|
6
|
+
_bd_timeout=${BEADS_HOOK_TIMEOUT:-300}
|
|
7
|
+
case "$_bd_timeout" in
|
|
8
|
+
*[!0-9]*|'') _bd_timeout_invalid=1 ;;
|
|
9
|
+
*[1-9]*) _bd_timeout_invalid=0 ;;
|
|
10
|
+
*) _bd_timeout_invalid=1 ;;
|
|
11
|
+
esac
|
|
12
|
+
if [ "$_bd_timeout_invalid" -eq 1 ]; then
|
|
13
|
+
echo >&2 "beads: invalid BEADS_HOOK_TIMEOUT; using 300 seconds"
|
|
14
|
+
_bd_timeout=300
|
|
15
|
+
fi
|
|
16
|
+
_bd_timeout_backend=none
|
|
17
|
+
_bd_timeout_command=
|
|
18
|
+
for _bd_timeout_candidate in timeout gtimeout; do
|
|
19
|
+
if command -v "$_bd_timeout_candidate" >/dev/null 2>&1; then
|
|
20
|
+
if _bd_timeout_version="$("$_bd_timeout_candidate" --version 2>/dev/null)"; then
|
|
21
|
+
case "$_bd_timeout_version" in
|
|
22
|
+
"timeout (GNU coreutils) "*) _bd_timeout_command=$_bd_timeout_candidate; break ;;
|
|
23
|
+
esac
|
|
24
|
+
fi
|
|
25
|
+
fi
|
|
26
|
+
done
|
|
27
|
+
if [ -n "$_bd_timeout_command" ]; then
|
|
28
|
+
_bd_timeout_backend=coreutils
|
|
29
|
+
if "$_bd_timeout_command" -- "$_bd_timeout" bd hooks run post-checkout "$@"; then
|
|
30
|
+
_bd_exit=0
|
|
31
|
+
else
|
|
32
|
+
_bd_exit=$?
|
|
33
|
+
fi
|
|
34
|
+
elif command -v perl >/dev/null 2>&1; then
|
|
35
|
+
_bd_timeout_backend=perl
|
|
36
|
+
if perl -e 'alarm shift; exec @ARGV' -- "$_bd_timeout" bd hooks run post-checkout "$@"; then
|
|
37
|
+
_bd_exit=0
|
|
38
|
+
else
|
|
39
|
+
_bd_exit=$?
|
|
40
|
+
fi
|
|
41
|
+
else
|
|
42
|
+
echo >&2 "beads: hook 'post-checkout' running without timeout; install coreutils or perl to enable BEADS_HOOK_TIMEOUT"
|
|
43
|
+
if bd hooks run post-checkout "$@"; then
|
|
44
|
+
_bd_exit=0
|
|
45
|
+
else
|
|
46
|
+
_bd_exit=$?
|
|
47
|
+
fi
|
|
48
|
+
fi
|
|
49
|
+
if { [ "$_bd_timeout_backend" = coreutils ] && [ "$_bd_exit" -eq 124 ]; } || { [ "$_bd_timeout_backend" = perl ] && [ "$_bd_exit" -eq 142 ]; }; then
|
|
50
|
+
echo >&2 "beads: hook 'post-checkout' timed out after ${_bd_timeout}s — continuing without beads"
|
|
51
|
+
_bd_exit=0
|
|
52
|
+
fi
|
|
53
|
+
if [ "$_bd_exit" -eq 3 ]; then
|
|
54
|
+
echo >&2 "beads: database not initialized — skipping hook 'post-checkout'"
|
|
55
|
+
_bd_exit=0
|
|
56
|
+
fi
|
|
57
|
+
if [ "$_bd_exit" -ne 0 ]; then exit "$_bd_exit"; fi
|
|
58
|
+
fi
|
|
59
|
+
# --- END BEADS INTEGRATION v1.3.0 ---
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
#!/usr/bin/env sh
|
|
2
|
+
# --- BEGIN BEADS INTEGRATION v1.3.0 ---
|
|
3
|
+
# This section is managed by beads. Do not remove these markers.
|
|
4
|
+
if command -v bd >/dev/null 2>&1; then
|
|
5
|
+
export BD_GIT_HOOK=1
|
|
6
|
+
_bd_timeout=${BEADS_HOOK_TIMEOUT:-300}
|
|
7
|
+
case "$_bd_timeout" in
|
|
8
|
+
*[!0-9]*|'') _bd_timeout_invalid=1 ;;
|
|
9
|
+
*[1-9]*) _bd_timeout_invalid=0 ;;
|
|
10
|
+
*) _bd_timeout_invalid=1 ;;
|
|
11
|
+
esac
|
|
12
|
+
if [ "$_bd_timeout_invalid" -eq 1 ]; then
|
|
13
|
+
echo >&2 "beads: invalid BEADS_HOOK_TIMEOUT; using 300 seconds"
|
|
14
|
+
_bd_timeout=300
|
|
15
|
+
fi
|
|
16
|
+
_bd_timeout_backend=none
|
|
17
|
+
_bd_timeout_command=
|
|
18
|
+
for _bd_timeout_candidate in timeout gtimeout; do
|
|
19
|
+
if command -v "$_bd_timeout_candidate" >/dev/null 2>&1; then
|
|
20
|
+
if _bd_timeout_version="$("$_bd_timeout_candidate" --version 2>/dev/null)"; then
|
|
21
|
+
case "$_bd_timeout_version" in
|
|
22
|
+
"timeout (GNU coreutils) "*) _bd_timeout_command=$_bd_timeout_candidate; break ;;
|
|
23
|
+
esac
|
|
24
|
+
fi
|
|
25
|
+
fi
|
|
26
|
+
done
|
|
27
|
+
if [ -n "$_bd_timeout_command" ]; then
|
|
28
|
+
_bd_timeout_backend=coreutils
|
|
29
|
+
if "$_bd_timeout_command" -- "$_bd_timeout" bd hooks run post-merge "$@"; then
|
|
30
|
+
_bd_exit=0
|
|
31
|
+
else
|
|
32
|
+
_bd_exit=$?
|
|
33
|
+
fi
|
|
34
|
+
elif command -v perl >/dev/null 2>&1; then
|
|
35
|
+
_bd_timeout_backend=perl
|
|
36
|
+
if perl -e 'alarm shift; exec @ARGV' -- "$_bd_timeout" bd hooks run post-merge "$@"; then
|
|
37
|
+
_bd_exit=0
|
|
38
|
+
else
|
|
39
|
+
_bd_exit=$?
|
|
40
|
+
fi
|
|
41
|
+
else
|
|
42
|
+
echo >&2 "beads: hook 'post-merge' running without timeout; install coreutils or perl to enable BEADS_HOOK_TIMEOUT"
|
|
43
|
+
if bd hooks run post-merge "$@"; then
|
|
44
|
+
_bd_exit=0
|
|
45
|
+
else
|
|
46
|
+
_bd_exit=$?
|
|
47
|
+
fi
|
|
48
|
+
fi
|
|
49
|
+
if { [ "$_bd_timeout_backend" = coreutils ] && [ "$_bd_exit" -eq 124 ]; } || { [ "$_bd_timeout_backend" = perl ] && [ "$_bd_exit" -eq 142 ]; }; then
|
|
50
|
+
echo >&2 "beads: hook 'post-merge' timed out after ${_bd_timeout}s — continuing without beads"
|
|
51
|
+
_bd_exit=0
|
|
52
|
+
fi
|
|
53
|
+
if [ "$_bd_exit" -eq 3 ]; then
|
|
54
|
+
echo >&2 "beads: database not initialized — skipping hook 'post-merge'"
|
|
55
|
+
_bd_exit=0
|
|
56
|
+
fi
|
|
57
|
+
if [ "$_bd_exit" -ne 0 ]; then exit "$_bd_exit"; fi
|
|
58
|
+
fi
|
|
59
|
+
# --- END BEADS INTEGRATION v1.3.0 ---
|