coulomb/markitect-tool
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Markdown-native knowledge toolkit providing a contract layer between semi-structured markdown and structured knowledge systems.
89 commits 1 branch 0 tags 617 KiB
Find a file
tegwick 0a5b15f8fd Add .repo-classification.yaml (CUST-WP-0050 T11 agent first-pass)
2026-06-22 17:47:38 +02:00
.claude/rules Add credential routing instructions for all agent runtimes 2026-06-18 22:48:38 +02:00
docs Add render reference asset manifest contract 2026-05-15 14:08:26 +02:00
examples Add render reference asset manifest contract 2026-05-15 14:08:26 +02:00
registry Add capability registry scaffold (REUSE-WP-0014-T06 B04) 2026-06-16 01:55:40 +02:00
src/markitect_tool Add render reference asset manifest contract 2026-05-15 14:08:26 +02:00
tests Add render reference asset manifest contract 2026-05-15 14:08:26 +02:00
wiki Intent and specification files 2026-05-03 19:26:51 +02:00
workplans Add render reference asset manifest contract 2026-05-15 14:08:26 +02:00
.custodian-brief.md chore(consistency): sync task status from DB [auto] 2026-05-15 14:07:17 +02:00
.gitignore Initial commit 2026-05-03 16:43:00 +00:00
.repo-classification.yaml Add .repo-classification.yaml (CUST-WP-0050 T11 agent first-pass) 2026-06-22 17:47:38 +02:00
AGENTS.md Add credential routing instructions for all agent runtimes 2026-06-18 22:48:38 +02:00
CLAUDE.md Add credential routing instructions for all agent runtimes 2026-06-18 22:48:38 +02:00
INTENT.md E2e tests and frist use docs 2026-05-04 22:58:59 +02:00
LICENSE Initial commit 2026-05-03 16:43:00 +00:00
pyproject.toml CLI and API polish 2026-05-04 21:56:19 +02:00
README.md source adapter framework 2026-05-14 22:05:34 +02:00
sbom-tools.yaml Initial schemas and validation with extension workplan 2026-05-03 22:12:46 +02:00
SCOPE.md Add repository scope profile 2026-05-15 15:20:34 +02:00

README.md

markitect-tool

markitect-tool is a markdown-native toolkit and CLI for turning semi-structured Markdown into structured, queryable, reusable knowledge artifacts.

This repository is the syntax-layer successor to the in-scope core of markitect-main. Its product boundary is defined in INTENT.md and the requirements documents in wiki/.

Start Here

  • INTENT.md - project purpose, boundaries, and design principles
  • wiki/ProductRequirementsDocument.md - product scope and success criteria
  • wiki/FunctionalRequirementsSpecification.md - observable functional behavior
  • docs/markitect-main-scope-assessment.md - migration assessment from markitect-main
  • docs/practical-usecase-relevance.md - practical adoption usecases and relevance expectations
  • docs/getting-started.md - first-use guide from checkout to practical commands
  • docs/command-cheatsheet.md - command-oriented workflow cheat sheet
  • docs/examples-index.md - map from examples to usecases and commands
  • docs/source-adapter-contract.md - v1 source adapter contract for external format adapters
  • docs/source-adapter-migration.md - sibling-repo handoff for source adapter adoption
  • docs/performance-notes.md - local performance posture and smoke coverage
  • docs/cli-reference.md - generated mkt command reference
  • docs/api-reference.md - generated public API reference
  • workplans/ - source-of-truth implementation and migration plans

State Hub

The repo is registered with the Custodian State Hub as markitect-tool under the markitect domain. See docs/state-hub-integration.md.

Development

Run the tests:

python3 -m pytest

Install locally from a checkout:

python3 -m pip install -e .
mkt --help

Try the parser CLI from a checkout:

PYTHONPATH=src python3 -m markitect_tool parse README.md --format tree

Generate shell completion and reference docs:

mkt completion bash > ~/.mkt-complete.bash
mkt docs cli --output docs/cli-reference.md
mkt docs api --output docs/api-reference.md