cli
Command-line interface for wiki_toolkit.
Commands parse arguments and delegate to wiki_toolkit’s domain modules; no business logic lives here.
| FUNCTION | DESCRIPTION |
|---|---|
batch_plan_cmd |
Split the files under SOURCE_DIR into batches for parallel wiki-ingest dispatch. |
build |
Regenerate docs/catalog.jsonl from the current docs/wiki/ notes. |
cli |
AI skills and helper tools that implement and maintain an LLM Wiki. |
commit_pages_cmd |
Commit PAGES onto the currently checked-out branch (a batch coordinator’s per-source streaming commit). |
config |
Inspect wiki_toolkit’s resolved configuration. |
config_show |
Print the resolved settings and which source (flag/env/dedicated_file/pyproject/default) each came from. |
cross_link_candidates_cmd |
Find literal title/alias mentions of other catalog pages inside PAGE_PATHS’ bodies (JSONL output). |
doctor |
Non-mutating health check of the wiki’s docs/ structure and git clone. |
init |
Scaffold a docs/ tree: sources/, wiki/, catalog.jsonl, log.jsonl, source-manifest.jsonl, schema.md. |
lint |
Validate wiki note frontmatter, allowed tags, source links, and source_count. |
log |
Append a structured entry to docs/log.jsonl. |
propose_pr_cmd |
Stage a wiki change as a local git branch + commit. Never pushes or opens a real PR. |
search_catalog_cmd |
Search docs/catalog.jsonl for entries matching –query. |
source_coverage_cmd |
Show which docs/sources/ files are covered by at least one wiki note. |
source_dedupe |
Suggest which docs/sources/ file to keep per group sharing a source id with a duplicate: true file. |
source_delta |
Diff a source’s current content against its last-known revision on main. |
source_lint |
Validate docs/sources/ frontmatter and report processed-but-uncovered sources. |
source_scan |
Classify docs/sources/ files as new, update, or duplicate. |
source_snapshot |
Write a new Raw snapshot unit for SOURCE, for a comments or fields mutation. |
start_branch_cmd |
Open a new local git branch for a batch coordinator session, before any source commits. |
Classes¶
Functions:¶
batch_plan_cmd
¶
batch_plan_cmd(context: Context, vault: Path, source_dir: Path) -> None
Split the files under SOURCE_DIR into batches for parallel wiki-ingest dispatch.
build
¶
build(context: Context) -> None
Regenerate docs/catalog.jsonl from the current docs/wiki/ notes.
cli
¶
cli(ctx: Context, docs_dir: Path | None, repo_root: Path | None) -> None
AI skills and helper tools that implement and maintain an LLM Wiki.
commit_pages_cmd
¶
commit_pages_cmd(
context: Context, pages: tuple[str, ...], message: str
) -> None
Commit PAGES onto the currently checked-out branch (a batch coordinator’s per-source streaming commit).
config_show
¶
config_show(context: Context) -> None
Print the resolved settings and which source (flag/env/dedicated_file/pyproject/default) each came from.
cross_link_candidates_cmd
¶
cross_link_candidates_cmd(
context: Context, page_paths: tuple[str, ...]
) -> None
Find literal title/alias mentions of other catalog pages inside PAGE_PATHS’ bodies (JSONL output).
doctor
¶
doctor(context: Context) -> None
Non-mutating health check of the wiki’s docs/ structure and git clone.
init
¶
init(context: Context) -> None
Scaffold a docs/ tree: sources/, wiki/, catalog.jsonl, log.jsonl, source-manifest.jsonl, schema.md.
lint
¶
lint(context: Context) -> None
Validate wiki note frontmatter, allowed tags, source links, and source_count.
log
¶
log(context: Context, message: str, details: str, action: str) -> None
Append a structured entry to docs/log.jsonl.
propose_pr_cmd
¶
propose_pr_cmd(context: Context, pages: tuple[str, ...], frame: str) -> None
Stage a wiki change as a local git branch + commit. Never pushes or opens a real PR.
search_catalog_cmd
¶
search_catalog_cmd(context: Context, query: str) -> None
Search docs/catalog.jsonl for entries matching –query.
source_coverage_cmd
¶
source_coverage_cmd(context: Context) -> None
Show which docs/sources/ files are covered by at least one wiki note.
source_dedupe
¶
source_dedupe(context: Context) -> None
Suggest which docs/sources/ file to keep per group sharing a source id with a duplicate: true file.
source_delta
¶
source_delta(context: Context, source: str) -> None
Diff a source’s current content against its last-known revision on main.
source_lint
¶
source_lint(context: Context) -> None
Validate docs/sources/ frontmatter and report processed-but-uncovered sources.
source_scan
¶
source_scan(
context: Context,
update_manifest: bool,
accept_covered: bool,
source_ids: tuple[str, ...],
) -> None
Classify docs/sources/ files as new, update, or duplicate.