mdcontext 0.0.1 → 0.2.0
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.
- package/.changeset/README.md +28 -0
- package/.changeset/config.json +11 -0
- package/.claude/settings.local.json +25 -0
- package/.github/workflows/ci.yml +83 -0
- package/.github/workflows/claude-code-review.yml +44 -0
- package/.github/workflows/claude.yml +85 -0
- package/.github/workflows/release.yml +113 -0
- package/.tldrignore +112 -0
- package/BACKLOG.md +338 -0
- package/CONTRIBUTING.md +186 -0
- package/NOTES/NOTES +44 -0
- package/README.md +434 -11
- package/biome.json +36 -0
- package/cspell.config.yaml +14 -0
- package/dist/chunk-23UPXDNL.js +3044 -0
- package/dist/chunk-2W7MO2DL.js +1366 -0
- package/dist/chunk-3NUAZGMA.js +1689 -0
- package/dist/chunk-7TOWB2XB.js +366 -0
- package/dist/chunk-7XOTOADQ.js +3065 -0
- package/dist/chunk-AH2PDM2K.js +3042 -0
- package/dist/chunk-BNXWSZ63.js +3742 -0
- package/dist/chunk-BTL5DJVU.js +3222 -0
- package/dist/chunk-HDHYG7E4.js +104 -0
- package/dist/chunk-HLR4KZBP.js +3234 -0
- package/dist/chunk-IP3FRFEB.js +1045 -0
- package/dist/chunk-KHU56VDO.js +3042 -0
- package/dist/chunk-KRYIFLQR.js +88 -0
- package/dist/chunk-LBSDNLEM.js +287 -0
- package/dist/chunk-MNTQ7HCP.js +2643 -0
- package/dist/chunk-MUJELQQ6.js +1387 -0
- package/dist/chunk-MXJGMSLV.js +2199 -0
- package/dist/chunk-N6QJGC3Z.js +2636 -0
- package/dist/chunk-OBELGBPM.js +1713 -0
- package/dist/chunk-OT7R5XTA.js +3192 -0
- package/dist/chunk-P7X4RA2T.js +106 -0
- package/dist/chunk-PIDUQNC2.js +3185 -0
- package/dist/chunk-POGCDIH4.js +3187 -0
- package/dist/chunk-PSIEOQGZ.js +3043 -0
- package/dist/chunk-PVRT3IHA.js +3238 -0
- package/dist/chunk-QNN4TT23.js +1430 -0
- package/dist/chunk-RE3R45RJ.js +3042 -0
- package/dist/chunk-S7E6TFX6.js +803 -0
- package/dist/chunk-SG6GLU4U.js +1378 -0
- package/dist/chunk-SJCDV2ST.js +274 -0
- package/dist/chunk-SYE5XLF3.js +104 -0
- package/dist/chunk-T5VLYBZD.js +103 -0
- package/dist/chunk-TOQB7VWU.js +3238 -0
- package/dist/chunk-VFNMZ4ZQ.js +3228 -0
- package/dist/chunk-VVTGZNBT.js +1629 -0
- package/dist/chunk-W7Q4RFEV.js +104 -0
- package/dist/chunk-XTYYVRLO.js +3190 -0
- package/dist/chunk-Y6MDYVJD.js +3063 -0
- package/dist/cli/main.d.ts +1 -0
- package/dist/cli/main.js +5458 -0
- package/dist/index.d.ts +653 -0
- package/dist/index.js +79 -0
- package/dist/mcp/server.d.ts +1 -0
- package/dist/mcp/server.js +472 -0
- package/dist/schema-BAWSG7KY.js +22 -0
- package/dist/schema-E3QUPL26.js +20 -0
- package/dist/schema-EHL7WUT6.js +20 -0
- package/docs/019-USAGE.md +625 -0
- package/docs/020-current-implementation.md +364 -0
- package/docs/021-DOGFOODING-FINDINGS.md +175 -0
- package/docs/BACKLOG.md +80 -0
- package/docs/CONFIG.md +1123 -0
- package/docs/DESIGN.md +439 -0
- package/docs/ERRORS.md +383 -0
- package/docs/PROJECT.md +88 -0
- package/docs/ROADMAP.md +407 -0
- package/docs/summarization.md +320 -0
- package/docs/test-links.md +9 -0
- package/justfile +40 -0
- package/package.json +74 -9
- package/pnpm-workspace.yaml +5 -0
- package/research/INDEX.md +315 -0
- package/research/code-review/README.md +90 -0
- package/research/code-review/cli-error-handling-review.md +979 -0
- package/research/code-review/code-review-validation-report.md +464 -0
- package/research/code-review/main-ts-review.md +1128 -0
- package/research/config-analysis/01-current-implementation.md +470 -0
- package/research/config-analysis/02-strategy-recommendation.md +428 -0
- package/research/config-analysis/03-task-candidates.md +715 -0
- package/research/config-analysis/033-research-configuration-management.md +828 -0
- package/research/config-analysis/034-research-effect-cli-config.md +1504 -0
- package/research/config-analysis/04-consolidated-task-candidates.md +277 -0
- package/research/config-docs/SUMMARY.md +357 -0
- package/research/config-docs/TEST-RESULTS.md +776 -0
- package/research/config-docs/TODO.md +542 -0
- package/research/config-docs/analysis.md +744 -0
- package/research/config-docs/fix-validation.md +502 -0
- package/research/config-docs/help-audit.md +264 -0
- package/research/config-docs/help-system-analysis.md +890 -0
- package/research/dogfood/consolidated-tool-evaluation.md +373 -0
- package/research/dogfood/strategy-a/a-synthesis.md +184 -0
- package/research/dogfood/strategy-a/a1-docs.md +226 -0
- package/research/dogfood/strategy-a/a2-amorphic.md +156 -0
- package/research/dogfood/strategy-a/a3-llm.md +164 -0
- package/research/dogfood/strategy-b/b-synthesis.md +228 -0
- package/research/dogfood/strategy-b/b1-architecture.md +207 -0
- package/research/dogfood/strategy-b/b2-gaps.md +258 -0
- package/research/dogfood/strategy-b/b3-workflows.md +250 -0
- package/research/dogfood/strategy-c/c-synthesis.md +451 -0
- package/research/dogfood/strategy-c/c1-explorer.md +192 -0
- package/research/dogfood/strategy-c/c2-diver-memory.md +145 -0
- package/research/dogfood/strategy-c/c3-diver-control.md +148 -0
- package/research/dogfood/strategy-c/c4-diver-failure.md +151 -0
- package/research/dogfood/strategy-c/c5-diver-execution.md +221 -0
- package/research/dogfood/strategy-c/c6-diver-org.md +221 -0
- package/research/effect-cli-error-handling.md +845 -0
- package/research/effect-errors-as-values.md +943 -0
- package/research/errors-task-analysis/00-consolidated-tasks.md +207 -0
- package/research/errors-task-analysis/cli-commands-analysis.md +909 -0
- package/research/errors-task-analysis/embeddings-analysis.md +709 -0
- package/research/errors-task-analysis/index-search-analysis.md +812 -0
- package/research/frontmatter/COMMENTS-ARE-SKIPPED.md +149 -0
- package/research/frontmatter/LLM-CODE-NAVIGATION.md +276 -0
- package/research/issue-review.md +603 -0
- package/research/llm-summarization/agent-cli-tools-2026.md +1082 -0
- package/research/llm-summarization/alternative-providers-2026.md +1428 -0
- package/research/llm-summarization/anthropic-2026.md +367 -0
- package/research/llm-summarization/claude-cli-integration.md +1706 -0
- package/research/llm-summarization/cli-integration-patterns.md +3155 -0
- package/research/llm-summarization/openai-2026.md +473 -0
- package/research/llm-summarization/openai-compatible-providers-2026.md +1022 -0
- package/research/llm-summarization/opencode-cli-integration.md +1552 -0
- package/research/llm-summarization/prompt-engineering-2026.md +1426 -0
- package/research/llm-summarization/prototype-results.md +56 -0
- package/research/llm-summarization/provider-switching-patterns-2026.md +2153 -0
- package/research/llm-summarization/typescript-llm-libraries-2026.md +2436 -0
- package/research/mdcontext-error-analysis.md +521 -0
- package/research/mdcontext-pudding/00-EXECUTIVE-SUMMARY.md +282 -0
- package/research/mdcontext-pudding/01-index-embed.md +956 -0
- package/research/mdcontext-pudding/02-search-COMMANDS.md +142 -0
- package/research/mdcontext-pudding/02-search-SUMMARY.md +146 -0
- package/research/mdcontext-pudding/02-search.md +970 -0
- package/research/mdcontext-pudding/03-context.md +779 -0
- package/research/mdcontext-pudding/04-navigation-and-analytics.md +803 -0
- package/research/mdcontext-pudding/04-tree.md +704 -0
- package/research/mdcontext-pudding/05-config.md +1038 -0
- package/research/mdcontext-pudding/06-links-summary.txt +87 -0
- package/research/mdcontext-pudding/06-links.md +679 -0
- package/research/mdcontext-pudding/07-stats.md +693 -0
- package/research/mdcontext-pudding/BUG-FIX-PLAN.md +388 -0
- package/research/mdcontext-pudding/P0-BUG-VALIDATION.md +167 -0
- package/research/mdcontext-pudding/README.md +168 -0
- package/research/mdcontext-pudding/TESTING-SUMMARY.md +128 -0
- package/research/npm_publish/011-npm-workflow-research-agent2.md +792 -0
- package/research/npm_publish/012-npm-workflow-research-agent1.md +530 -0
- package/research/npm_publish/013-npm-workflow-research-agent3.md +722 -0
- package/research/npm_publish/014-npm-workflow-synthesis.md +556 -0
- package/research/npm_publish/031-npm-workflow-task-analysis.md +134 -0
- package/research/research-quality-review.md +834 -0
- package/research/semantic-search/002-research-embedding-models.md +490 -0
- package/research/semantic-search/003-research-rag-alternatives.md +523 -0
- package/research/semantic-search/004-research-vector-search.md +841 -0
- package/research/semantic-search/032-research-semantic-search.md +427 -0
- package/research/semantic-search/embedding-text-analysis.md +156 -0
- package/research/semantic-search/multi-word-failure-reproduction.md +171 -0
- package/research/semantic-search/query-processing-analysis.md +207 -0
- package/research/semantic-search/root-cause-and-solution.md +114 -0
- package/research/semantic-search/threshold-validation-report.md +69 -0
- package/research/semantic-search/vector-search-analysis.md +63 -0
- package/research/task-management-2026/00-synthesis-recommendations.md +295 -0
- package/research/task-management-2026/01-ai-workflow-tools.md +416 -0
- package/research/task-management-2026/02-agent-framework-patterns.md +476 -0
- package/research/task-management-2026/03-lightweight-file-based.md +567 -0
- package/research/task-management-2026/04-established-tools-ai-features.md +541 -0
- package/research/task-management-2026/linear/01-core-features-workflow.md +771 -0
- package/research/task-management-2026/linear/02-api-integrations.md +930 -0
- package/research/task-management-2026/linear/03-ai-features.md +368 -0
- package/research/task-management-2026/linear/04-pricing-setup.md +205 -0
- package/research/task-management-2026/linear/05-usage-patterns-best-practices.md +605 -0
- package/research/test-path-issues.md +276 -0
- package/review/ALP-76/1-error-type-design.md +962 -0
- package/review/ALP-76/2-error-handling-patterns.md +906 -0
- package/review/ALP-76/3-error-presentation.md +624 -0
- package/review/ALP-76/4-test-coverage.md +625 -0
- package/review/ALP-76/5-migration-completeness.md +440 -0
- package/review/ALP-76/6-effect-best-practices.md +755 -0
- package/scripts/apply-branch-protection.sh +47 -0
- package/scripts/branch-protection-templates.json +79 -0
- package/scripts/prototype-summarization.ts +346 -0
- package/scripts/rebuild-hnswlib.js +58 -0
- package/scripts/setup-branch-protection.sh +64 -0
- package/src/__tests__/fixtures/semantic-search/multi-word-corpus/.mdcontext/active-provider.json +7 -0
- package/src/__tests__/fixtures/semantic-search/multi-word-corpus/.mdcontext/bm25.json +541 -0
- package/src/__tests__/fixtures/semantic-search/multi-word-corpus/.mdcontext/bm25.meta.json +5 -0
- package/src/__tests__/fixtures/semantic-search/multi-word-corpus/.mdcontext/config.json +8 -0
- package/src/__tests__/fixtures/semantic-search/multi-word-corpus/.mdcontext/embeddings/openai_text-embedding-3-small_512/vectors.bin +0 -0
- package/src/__tests__/fixtures/semantic-search/multi-word-corpus/.mdcontext/embeddings/openai_text-embedding-3-small_512/vectors.meta.bin +0 -0
- package/src/__tests__/fixtures/semantic-search/multi-word-corpus/.mdcontext/indexes/documents.json +60 -0
- package/src/__tests__/fixtures/semantic-search/multi-word-corpus/.mdcontext/indexes/links.json +13 -0
- package/src/__tests__/fixtures/semantic-search/multi-word-corpus/.mdcontext/indexes/sections.json +1197 -0
- package/src/__tests__/fixtures/semantic-search/multi-word-corpus/configuration-management.md +99 -0
- package/src/__tests__/fixtures/semantic-search/multi-word-corpus/distributed-systems.md +92 -0
- package/src/__tests__/fixtures/semantic-search/multi-word-corpus/error-handling.md +78 -0
- package/src/__tests__/fixtures/semantic-search/multi-word-corpus/failure-automation.md +55 -0
- package/src/__tests__/fixtures/semantic-search/multi-word-corpus/job-context.md +69 -0
- package/src/__tests__/fixtures/semantic-search/multi-word-corpus/process-orchestration.md +99 -0
- package/src/cli/argv-preprocessor.test.ts +210 -0
- package/src/cli/argv-preprocessor.ts +202 -0
- package/src/cli/cli.test.ts +627 -0
- package/src/cli/commands/backlinks.ts +54 -0
- package/src/cli/commands/config-cmd.ts +642 -0
- package/src/cli/commands/context.ts +285 -0
- package/src/cli/commands/duplicates.ts +122 -0
- package/src/cli/commands/embeddings.ts +529 -0
- package/src/cli/commands/index-cmd.ts +480 -0
- package/src/cli/commands/index.ts +16 -0
- package/src/cli/commands/links.ts +52 -0
- package/src/cli/commands/search.ts +1281 -0
- package/src/cli/commands/stats.ts +149 -0
- package/src/cli/commands/tree.ts +128 -0
- package/src/cli/config-layer.ts +176 -0
- package/src/cli/error-handler.test.ts +235 -0
- package/src/cli/error-handler.ts +655 -0
- package/src/cli/flag-schemas.ts +341 -0
- package/src/cli/help.ts +588 -0
- package/src/cli/index.ts +9 -0
- package/src/cli/main.ts +435 -0
- package/src/cli/options.ts +41 -0
- package/src/cli/shared-error-handling.ts +199 -0
- package/src/cli/typo-suggester.test.ts +105 -0
- package/src/cli/typo-suggester.ts +130 -0
- package/src/cli/utils.ts +259 -0
- package/src/config/file-provider.test.ts +320 -0
- package/src/config/file-provider.ts +273 -0
- package/src/config/index.ts +72 -0
- package/src/config/integration.test.ts +667 -0
- package/src/config/precedence.test.ts +277 -0
- package/src/config/precedence.ts +451 -0
- package/src/config/schema.test.ts +414 -0
- package/src/config/schema.ts +603 -0
- package/src/config/service.test.ts +320 -0
- package/src/config/service.ts +243 -0
- package/src/config/testing.test.ts +264 -0
- package/src/config/testing.ts +110 -0
- package/src/core/index.ts +1 -0
- package/src/core/types.ts +113 -0
- package/src/duplicates/detector.test.ts +183 -0
- package/src/duplicates/detector.ts +414 -0
- package/src/duplicates/index.ts +18 -0
- package/src/embeddings/embedding-namespace.test.ts +300 -0
- package/src/embeddings/embedding-namespace.ts +947 -0
- package/src/embeddings/heading-boost.test.ts +222 -0
- package/src/embeddings/hnsw-build-options.test.ts +198 -0
- package/src/embeddings/hyde.test.ts +272 -0
- package/src/embeddings/hyde.ts +264 -0
- package/src/embeddings/index.ts +10 -0
- package/src/embeddings/openai-provider.ts +414 -0
- package/src/embeddings/pricing.json +22 -0
- package/src/embeddings/provider-constants.ts +204 -0
- package/src/embeddings/provider-errors.test.ts +967 -0
- package/src/embeddings/provider-errors.ts +565 -0
- package/src/embeddings/provider-factory.test.ts +240 -0
- package/src/embeddings/provider-factory.ts +225 -0
- package/src/embeddings/provider-integration.test.ts +788 -0
- package/src/embeddings/query-preprocessing.test.ts +187 -0
- package/src/embeddings/semantic-search-threshold.test.ts +508 -0
- package/src/embeddings/semantic-search.ts +1270 -0
- package/src/embeddings/types.ts +359 -0
- package/src/embeddings/vector-store.ts +708 -0
- package/src/embeddings/voyage-provider.ts +313 -0
- package/src/errors/errors.test.ts +845 -0
- package/src/errors/index.ts +533 -0
- package/src/index/ignore-patterns.test.ts +354 -0
- package/src/index/ignore-patterns.ts +305 -0
- package/src/index/index.ts +4 -0
- package/src/index/indexer.ts +684 -0
- package/src/index/storage.ts +260 -0
- package/src/index/types.ts +147 -0
- package/src/index/watcher.ts +189 -0
- package/src/index.ts +30 -0
- package/src/integration/search-keyword.test.ts +678 -0
- package/src/mcp/server.ts +612 -0
- package/src/parser/index.ts +1 -0
- package/src/parser/parser.test.ts +291 -0
- package/src/parser/parser.ts +394 -0
- package/src/parser/section-filter.test.ts +277 -0
- package/src/parser/section-filter.ts +392 -0
- package/src/search/__tests__/hybrid-search.test.ts +650 -0
- package/src/search/bm25-store.ts +366 -0
- package/src/search/cross-encoder.test.ts +253 -0
- package/src/search/cross-encoder.ts +406 -0
- package/src/search/fuzzy-search.test.ts +419 -0
- package/src/search/fuzzy-search.ts +273 -0
- package/src/search/hybrid-search.ts +448 -0
- package/src/search/path-matcher.test.ts +276 -0
- package/src/search/path-matcher.ts +33 -0
- package/src/search/query-parser.test.ts +260 -0
- package/src/search/query-parser.ts +319 -0
- package/src/search/searcher.test.ts +280 -0
- package/src/search/searcher.ts +724 -0
- package/src/search/wink-bm25.d.ts +30 -0
- package/src/summarization/cli-providers/claude.ts +202 -0
- package/src/summarization/cli-providers/detection.test.ts +273 -0
- package/src/summarization/cli-providers/detection.ts +118 -0
- package/src/summarization/cli-providers/index.ts +8 -0
- package/src/summarization/cost.test.ts +139 -0
- package/src/summarization/cost.ts +102 -0
- package/src/summarization/error-handler.test.ts +127 -0
- package/src/summarization/error-handler.ts +111 -0
- package/src/summarization/index.ts +102 -0
- package/src/summarization/pipeline.test.ts +498 -0
- package/src/summarization/pipeline.ts +231 -0
- package/src/summarization/prompts.test.ts +269 -0
- package/src/summarization/prompts.ts +133 -0
- package/src/summarization/provider-factory.test.ts +396 -0
- package/src/summarization/provider-factory.ts +178 -0
- package/src/summarization/types.ts +184 -0
- package/src/summarize/budget-bugs.test.ts +620 -0
- package/src/summarize/formatters.ts +419 -0
- package/src/summarize/index.ts +20 -0
- package/src/summarize/summarizer.test.ts +275 -0
- package/src/summarize/summarizer.ts +597 -0
- package/src/summarize/verify-bugs.test.ts +238 -0
- package/src/types/huggingface-transformers.d.ts +66 -0
- package/src/utils/index.ts +1 -0
- package/src/utils/tokens.test.ts +142 -0
- package/src/utils/tokens.ts +186 -0
- package/tests/fixtures/cli/.mdcontext/active-provider.json +7 -0
- package/tests/fixtures/cli/.mdcontext/config.json +8 -0
- package/tests/fixtures/cli/.mdcontext/embeddings/openai_text-embedding-3-small_512/vectors.bin +0 -0
- package/tests/fixtures/cli/.mdcontext/embeddings/openai_text-embedding-3-small_512/vectors.meta.bin +0 -0
- package/tests/fixtures/cli/.mdcontext/indexes/documents.json +33 -0
- package/tests/fixtures/cli/.mdcontext/indexes/links.json +12 -0
- package/tests/fixtures/cli/.mdcontext/indexes/sections.json +247 -0
- package/tests/fixtures/cli/README.md +9 -0
- package/tests/fixtures/cli/api-reference.md +11 -0
- package/tests/fixtures/cli/getting-started.md +11 -0
- package/tests/integration/embed-index.test.ts +712 -0
- package/tests/integration/search-context.test.ts +469 -0
- package/tests/integration/search-semantic.test.ts +522 -0
- package/tsconfig.json +26 -0
- package/vitest.config.ts +16 -0
- package/vitest.setup.ts +12 -0
|
@@ -0,0 +1,295 @@
|
|
|
1
|
+
# Task Management for Ralph: Synthesis & Recommendations
|
|
2
|
+
|
|
3
|
+
**Date:** January 21, 2026
|
|
4
|
+
**Purpose:** Recommend a task management approach for capturing intent before AI agent (ralph) processing
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Executive Summary
|
|
9
|
+
|
|
10
|
+
**For capturing task intent in an AI agent workflow, use a file-based SPEC.md pattern stored in Git.** This approach offers the best balance of human usability, LLM compatibility, and zero friction. External tools like Linear or GitHub Issues add unnecessary complexity for the core problem of "capture intent quickly so ralph can act on it." The SPEC.md pattern is already proven in the codebase, requires no new tooling, and aligns with the emerging industry standard of spec-driven development. Reserve external tools (Linear, GitHub Issues) for team coordination and visibility, not for the AI agent interface.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Context
|
|
15
|
+
|
|
16
|
+
### The Problem
|
|
17
|
+
|
|
18
|
+
We need a system for capturing task intent before processing through "ralph" (an AI agent orchestration system). This is specifically about the **input interface** to the agent, not project management at large.
|
|
19
|
+
|
|
20
|
+
### Requirements
|
|
21
|
+
|
|
22
|
+
| Requirement | Priority | Notes |
|
|
23
|
+
| --------------------------- | -------- | --------------------------------------- |
|
|
24
|
+
| Capture task intent quickly | Critical | Friction kills adoption |
|
|
25
|
+
| LLM-friendly format | Critical | Ralph must parse and understand it |
|
|
26
|
+
| Git-native | High | Version control, audit trail, offline |
|
|
27
|
+
| Low friction for humans | High | Must be faster than "just do it myself" |
|
|
28
|
+
| Scales to many tasks | Medium | Backlog accumulation, parallel work |
|
|
29
|
+
|
|
30
|
+
### Constraint
|
|
31
|
+
|
|
32
|
+
Ralph operates on files in a repository. Whatever system we choose must either:
|
|
33
|
+
|
|
34
|
+
1. **Live in the repo** (file-based), or
|
|
35
|
+
2. **Be accessible via MCP/API** (external tool)
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## Options Matrix
|
|
40
|
+
|
|
41
|
+
### Top 4 Approaches Evaluated
|
|
42
|
+
|
|
43
|
+
| Approach | Quick Capture | LLM-Friendly | Git-Native | Low Friction | Scales | Overall |
|
|
44
|
+
| ------------------- | ------------- | ------------ | ---------- | ------------ | ------ | ------- |
|
|
45
|
+
| **SPEC.md Pattern** | A | A | A | A | B | **A** |
|
|
46
|
+
| **Backlog.md** | B | A | A | B | A | **A-** |
|
|
47
|
+
| **Linear** | B | B | C | A | A | **B+** |
|
|
48
|
+
| **GitHub Issues** | C | B | B | B | A | **B** |
|
|
49
|
+
|
|
50
|
+
### Detailed Analysis
|
|
51
|
+
|
|
52
|
+
#### 1. SPEC.md Pattern (File-Based Specifications)
|
|
53
|
+
|
|
54
|
+
**What it is:** Markdown files in the repo (e.g., `SPEC.md`, `TODO.md`, `PLAN.md`) that define task intent. Already emerging as the industry standard for AI-assisted development in 2026.
|
|
55
|
+
|
|
56
|
+
**Pros:**
|
|
57
|
+
|
|
58
|
+
- Zero dependencies - works with any editor, any AI tool
|
|
59
|
+
- Direct context injection into LLM prompts (no API calls)
|
|
60
|
+
- Git versioning provides audit trail and rollback for free
|
|
61
|
+
- Human and AI edit the same artifact
|
|
62
|
+
- Token-efficient format (markdown is LLM-native)
|
|
63
|
+
- Already using something similar in the codebase
|
|
64
|
+
|
|
65
|
+
**Cons:**
|
|
66
|
+
|
|
67
|
+
- No built-in visualization (Kanban, timelines)
|
|
68
|
+
- Requires discipline to maintain structure
|
|
69
|
+
- Doesn't scale well for team-wide coordination across multiple projects
|
|
70
|
+
|
|
71
|
+
**Best for:** Individual or small team AI coding workflows where the developer is the primary user.
|
|
72
|
+
|
|
73
|
+
#### 2. Backlog.md
|
|
74
|
+
|
|
75
|
+
**What it is:** Purpose-built tool for AI-human collaboration. Each task is a separate `.md` file in a `.backlog/` directory. CLI and web interface available.
|
|
76
|
+
|
|
77
|
+
**Pros:**
|
|
78
|
+
|
|
79
|
+
- Designed specifically for AI agent workflows
|
|
80
|
+
- Git-native with task IDs referencing commits/branches
|
|
81
|
+
- Terminal Kanban for visualization
|
|
82
|
+
- Works with Claude Code, Cursor, and MCP-compatible tools
|
|
83
|
+
- Open source, no vendor lock-in
|
|
84
|
+
|
|
85
|
+
**Cons:**
|
|
86
|
+
|
|
87
|
+
- Adds a tool/CLI dependency
|
|
88
|
+
- Slightly more structure than bare SPEC.md
|
|
89
|
+
- Newer tool with smaller community
|
|
90
|
+
|
|
91
|
+
**Best for:** Teams wanting more structure than plain markdown but still git-native.
|
|
92
|
+
|
|
93
|
+
#### 3. Linear
|
|
94
|
+
|
|
95
|
+
**What it is:** The leading AI-native project management tool. Treats AI agents as "full teammates" with native integrations to Cursor, Copilot, and Claude.
|
|
96
|
+
|
|
97
|
+
**Pros:**
|
|
98
|
+
|
|
99
|
+
- Best-in-class AI agent integration (agents as assignable teammates)
|
|
100
|
+
- Excellent API and MCP servers
|
|
101
|
+
- Team visibility and coordination features
|
|
102
|
+
- Fast, keyboard-first UI
|
|
103
|
+
|
|
104
|
+
**Cons:**
|
|
105
|
+
|
|
106
|
+
- External service (not in repo)
|
|
107
|
+
- Requires MCP/API integration for ralph to access
|
|
108
|
+
- Adds latency to task capture (open tool, create issue)
|
|
109
|
+
- Paid at scale ($8/user/month)
|
|
110
|
+
- Another tool to maintain
|
|
111
|
+
|
|
112
|
+
**Best for:** Team coordination, roadmap visibility, when multiple people need to see task status.
|
|
113
|
+
|
|
114
|
+
#### 4. GitHub Issues
|
|
115
|
+
|
|
116
|
+
**What it is:** GitHub's built-in issue tracker, now with Copilot coding agent that can be assigned issues directly.
|
|
117
|
+
|
|
118
|
+
**Pros:**
|
|
119
|
+
|
|
120
|
+
- Already using GitHub
|
|
121
|
+
- Copilot can autonomously work on issues
|
|
122
|
+
- No new tool adoption
|
|
123
|
+
- Free
|
|
124
|
+
|
|
125
|
+
**Cons:**
|
|
126
|
+
|
|
127
|
+
- Slow to create issues (web UI friction)
|
|
128
|
+
- Not optimized for quick intent capture
|
|
129
|
+
- Less LLM-friendly than markdown files
|
|
130
|
+
- Requires API calls for ralph to read
|
|
131
|
+
|
|
132
|
+
**Best for:** When you need the issue-to-PR workflow with Copilot, team-visible bug tracking.
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
## Recommendation
|
|
137
|
+
|
|
138
|
+
### Primary: SPEC.md Pattern
|
|
139
|
+
|
|
140
|
+
**Use file-based specifications as the primary interface between humans and ralph.**
|
|
141
|
+
|
|
142
|
+
#### Rationale
|
|
143
|
+
|
|
144
|
+
1. **Lowest friction for capture:** Open file, write intent, save. Done. No context switching to another tool.
|
|
145
|
+
|
|
146
|
+
2. **Best LLM compatibility:** Markdown is the native language of LLMs. No translation layer, no API calls, no token overhead from structured formats.
|
|
147
|
+
|
|
148
|
+
3. **Already proven:** The research shows spec-driven development is the emerging standard. GitHub Spec-Kit, JetBrains Junie, Amazon Kiro - all use this pattern.
|
|
149
|
+
|
|
150
|
+
4. **Git-native by default:** Every change is versioned. Branching allows parallel task exploration. History shows what was attempted and why.
|
|
151
|
+
|
|
152
|
+
5. **Zero new tooling:** Works today with the existing setup. No adoption curve, no dependencies to maintain.
|
|
153
|
+
|
|
154
|
+
6. **Context window optimization:** Files can be selectively loaded. Large backlogs don't need to be sent to the LLM - only the relevant spec.
|
|
155
|
+
|
|
156
|
+
#### Proposed File Structure
|
|
157
|
+
|
|
158
|
+
```
|
|
159
|
+
.ralph/
|
|
160
|
+
BACKLOG.md # Quick task capture (one-liner ideas)
|
|
161
|
+
active/
|
|
162
|
+
feature-x.spec.md # Detailed spec for in-progress work
|
|
163
|
+
bug-fix-y.spec.md
|
|
164
|
+
completed/ # Archived specs (reference/learning)
|
|
165
|
+
templates/
|
|
166
|
+
feature.spec.md # Template for new features
|
|
167
|
+
bugfix.spec.md # Template for bug fixes
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
#### Spec File Format
|
|
171
|
+
|
|
172
|
+
```markdown
|
|
173
|
+
# [Task Title]
|
|
174
|
+
|
|
175
|
+
## Intent
|
|
176
|
+
|
|
177
|
+
[One paragraph: What do we want to accomplish and why?]
|
|
178
|
+
|
|
179
|
+
## Success Criteria
|
|
180
|
+
|
|
181
|
+
- [ ] Criterion 1
|
|
182
|
+
- [ ] Criterion 2
|
|
183
|
+
- [ ] Criterion 3
|
|
184
|
+
|
|
185
|
+
## Context
|
|
186
|
+
|
|
187
|
+
[Any relevant background, links, constraints]
|
|
188
|
+
|
|
189
|
+
## Notes
|
|
190
|
+
|
|
191
|
+
[Optional: implementation hints, considerations]
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
### Secondary: Linear for Team Visibility
|
|
195
|
+
|
|
196
|
+
**If you need team coordination or external visibility, sync completed specs to Linear.**
|
|
197
|
+
|
|
198
|
+
- Use Linear for roadmap and sprint planning
|
|
199
|
+
- Use Linear for stakeholder visibility
|
|
200
|
+
- Keep ralph's input interface file-based
|
|
201
|
+
- Consider automation: completed specs could auto-create Linear issues for tracking
|
|
202
|
+
|
|
203
|
+
### Why Not Linear as Primary?
|
|
204
|
+
|
|
205
|
+
Linear is excellent, but it adds friction to the core workflow:
|
|
206
|
+
|
|
207
|
+
1. **Context switch:** You're in your editor, you have an idea, you have to open Linear
|
|
208
|
+
2. **API dependency:** Ralph needs MCP/API calls instead of file reads
|
|
209
|
+
3. **Not the source of truth:** The code is in git, the spec should be too
|
|
210
|
+
4. **Overkill for capture:** Linear is optimized for team coordination, not quick intent capture
|
|
211
|
+
|
|
212
|
+
Linear makes sense for _visibility and coordination_, not for _AI agent input_.
|
|
213
|
+
|
|
214
|
+
### Why Not Backlog.md?
|
|
215
|
+
|
|
216
|
+
Backlog.md is well-designed and could work. However:
|
|
217
|
+
|
|
218
|
+
1. **Adds a dependency** for marginal benefit over plain markdown
|
|
219
|
+
2. **Learning curve** for the CLI and conventions
|
|
220
|
+
3. **SPEC.md is simpler** and already aligns with industry patterns
|
|
221
|
+
|
|
222
|
+
If the team grows or the backlog becomes complex, Backlog.md is a good upgrade path.
|
|
223
|
+
|
|
224
|
+
---
|
|
225
|
+
|
|
226
|
+
## Implementation Path
|
|
227
|
+
|
|
228
|
+
### Phase 1: Establish the Pattern (Day 1)
|
|
229
|
+
|
|
230
|
+
1. Create `.ralph/` directory structure
|
|
231
|
+
2. Create `BACKLOG.md` for quick capture
|
|
232
|
+
3. Create spec templates
|
|
233
|
+
4. Document the pattern in CLAUDE.md
|
|
234
|
+
|
|
235
|
+
### Phase 2: Integrate with Ralph (Week 1)
|
|
236
|
+
|
|
237
|
+
1. Update ralph to look for specs in `.ralph/active/`
|
|
238
|
+
2. Implement spec parsing (extract intent, success criteria)
|
|
239
|
+
3. Add success criteria tracking (ralph marks criteria complete)
|
|
240
|
+
4. Move completed specs to `.ralph/completed/`
|
|
241
|
+
|
|
242
|
+
### Phase 3: Optimize (Ongoing)
|
|
243
|
+
|
|
244
|
+
1. Refine templates based on what works
|
|
245
|
+
2. Consider auto-sync to Linear for visibility (if needed)
|
|
246
|
+
3. Add tooling for quick spec creation (CLI or editor shortcuts)
|
|
247
|
+
|
|
248
|
+
### Example Workflow
|
|
249
|
+
|
|
250
|
+
```bash
|
|
251
|
+
# Human captures intent quickly
|
|
252
|
+
echo "# Add dark mode support
|
|
253
|
+
|
|
254
|
+
## Intent
|
|
255
|
+
Users want dark mode to reduce eye strain during night coding sessions.
|
|
256
|
+
|
|
257
|
+
## Success Criteria
|
|
258
|
+
- [ ] Toggle in settings
|
|
259
|
+
- [ ] Persists across sessions
|
|
260
|
+
- [ ] Respects system preference by default
|
|
261
|
+
" > .ralph/active/dark-mode.spec.md
|
|
262
|
+
|
|
263
|
+
# Ralph picks it up and executes
|
|
264
|
+
ralph process .ralph/active/dark-mode.spec.md
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
---
|
|
268
|
+
|
|
269
|
+
## Decision Summary
|
|
270
|
+
|
|
271
|
+
| Decision | Choice | Confidence |
|
|
272
|
+
| ----------------------- | ----------------------------------- | ---------- |
|
|
273
|
+
| Primary task capture | SPEC.md files in `.ralph/` | High |
|
|
274
|
+
| Format | Markdown with structured sections | High |
|
|
275
|
+
| Location | Git repository | High |
|
|
276
|
+
| Team coordination | Linear (optional, secondary) | Medium |
|
|
277
|
+
| External issue tracking | GitHub Issues (for bugs, community) | Medium |
|
|
278
|
+
|
|
279
|
+
---
|
|
280
|
+
|
|
281
|
+
## Sources
|
|
282
|
+
|
|
283
|
+
This synthesis is based on four research documents:
|
|
284
|
+
|
|
285
|
+
1. **01-ai-workflow-tools.md** - Survey of AI-native task management tools (Linear, Taskade, Backlog.md, Plane.so, etc.)
|
|
286
|
+
2. **02-agent-framework-patterns.md** - How AI agent frameworks (LangGraph, CrewAI, Claude Code) handle task persistence
|
|
287
|
+
3. **03-lightweight-file-based.md** - File-based approaches (SPEC.md, Beads, todo.txt, etc.)
|
|
288
|
+
4. **04-established-tools-ai-features.md** - AI features in GitHub, Linear, Jira, Notion
|
|
289
|
+
|
|
290
|
+
Key external sources informing this recommendation:
|
|
291
|
+
|
|
292
|
+
- [GitHub Spec-Kit](https://github.com/github/spec-kit/blob/main/spec-driven.md)
|
|
293
|
+
- [Addy Osmani on specs for AI agents](https://addyosmani.com/blog/good-spec/)
|
|
294
|
+
- [Steve Yegge on coding agent memory](https://steve-yegge.medium.com/introducing-beads-a-coding-agent-memory-system-637d7d92514a)
|
|
295
|
+
- [Thoughtworks on Spec-Driven Development](https://www.thoughtworks.com/en-us/insights/blog/agile-engineering-practices/spec-driven-development-unpacking-2025-new-engineering-practices)
|