Directories
¶
| Path | Synopsis |
|---|---|
|
Package actions performs the human verdicts of the review queue (spec §12.1): `kb review accept|reject` dispatches each item to the action of its queue (keep or quarantine a gated source, rescue a skipped item, recapture a broken page, write a relation or a body link, create a stub concept, record an OKF type verdict), appends the verdict as a label (spec §12.2) and resolves the item.
|
Package actions performs the human verdicts of the review queue (spec §12.1): `kb review accept|reject` dispatches each item to the action of its queue (keep or quarantine a gated source, rescue a skipped item, recapture a broken page, write a relation or a body link, create a stub concept, record an OKF type verdict), appends the verdict as a label (spec §12.2) and resolves the item. |
|
Package adapter provides tree-sitter parsing adapters that extract symbols, relations, and diagnostics from Go, TypeScript, JavaScript, and Rust source files.
|
Package adapter provides tree-sitter parsing adapters that extract symbols, relations, and diagnostics from Go, TypeScript, JavaScript, and Rust source files. |
|
Package classify judges every document of a topic once on a fixed set of facets (spec §8) and writes them as kb-owned frontmatter: genre, depth, relevance, quality, concepts, plus the generated literals summary, entities, questions and, for articles, criterion and aliases.
|
Package classify judges every document of a topic once on a fixed set of facets (spec §8) and writes them as kb-owned frontmatter: genre, depth, relevance, quality, concepts, plus the generated literals summary, entities, questions and, for articles, criterion and aliases. |
|
Package config loads TOML configuration and environment-backed runtime overrides for the kb CLI.
|
Package config loads TOML configuration and environment-backed runtime overrides for the kb CLI. |
|
Package contract owns a topic's selection contract (spec §5.1): the five-part scope that relevance and classification questions are judged against.
|
Package contract owns a topic's selection contract (spec §5.1): the five-part scope that relevance and classification questions are judged against. |
|
topicyaml
Package topicyaml edits a topic's topic.yaml at the yaml.Node level so every key, comment and key order that the caller does not touch survives a write.
|
Package topicyaml edits a topic's topic.yaml at the yaml.Node level so every key, comment and key order that the caller does not touch survives a write. |
|
Package convert provides a converter registry and format-specific converters that transform files (PDF, DOCX, XLSX, PPTX, EPUB, HTML, CSV, JSON, XML, text, images) into markdown.
|
Package convert provides a converter registry and format-specific converters that transform files (PDF, DOCX, XLSX, PPTX, EPUB, HTML, CSV, JSON, XML, text, images) into markdown. |
|
Package corpus loads a topic's documents (sources and wiki articles) and provides everything decisions need to reason about them without a model: body hashes, value hashes, BM25 retrieval, the alias dictionary and mention scan, section-aware excerpts, provenance state, the `.decisions/state.jsonl` store and the byte-preserving owned-key writer.
|
Package corpus loads a topic's documents (sources and wiki articles) and provides everything decisions need to reason about them without a model: body hashes, value hashes, BM25 retrieval, the alias dictionary and mention scan, section-aware excerpts, provenance state, the `.decisions/state.jsonl` store and the byte-preserving owned-key writer. |
|
Package decisions is kb's decision engine: one entry point (Engine.Decide) that owns transport to the decision model, receipt validation, the per-topic receipts cache, banding, budget, concurrency and run summaries.
|
Package decisions is kb's decision engine: one entry point (Engine.Decide) that owns transport to the decision model, receipt validation, the per-topic receipts cache, banding, budget, concurrency and run summaries. |
|
Package fakes provides httptest servers standing in for the three network boundaries of decision-backed kb flows: the OpenRouter decisions endpoint (Jev), OpenRouter chat completions (generation) and Firecrawl scrape.
|
Package fakes provides httptest servers standing in for the three network boundaries of decision-backed kb flows: the OpenRouter decisions endpoint (Jev), OpenRouter chat completions (generation) and Firecrawl scrape. |
|
Package find is kb's retrieval judge (spec §10): code proposes candidates (frontmatter facet filters, BM25, concept expansion, optional vectors), the decision model judges whether each candidate answers the question, and code ranks the survivors and names the reason every other candidate was dropped.
|
Package find is kb's retrieval judge (spec §10): code proposes candidates (frontmatter facet filters, BM25, concept expansion, optional vectors), the decision model judges whether each candidate answers the question, and code ranks the survivors and names the reason every other candidate was dropped. |
|
Package firecrawl provides a client for the Firecrawl REST API.
|
Package firecrawl provides a client for the Firecrawl REST API. |
|
Package frontmatter provides helpers for parsing and generating YAML frontmatter in markdown documents.
|
Package frontmatter provides helpers for parsing and generating YAML frontmatter in markdown documents. |
|
Package gate runs the ingest gates of spec §7 over sources about to enter a topic.
|
Package gate runs the ingest gates of spec §7 over sources about to enter a topic. |
|
Package generate orchestrates the codebase-to-vault pipeline: scan, parse, normalize, compute metrics, render, and write.
|
Package generate orchestrates the codebase-to-vault pipeline: scan, parse, normalize, compute metrics, render, and write. |
|
Package generation is kb's client for the generation model: short literals (summaries, aliases, criteria, drafts) over OpenRouter chat completions with a strict JSON schema and reasoning disabled.
|
Package generation is kb's client for the generation model: short literals (summaries, aliases, criteria, drafts) over OpenRouter chat completions with a strict JSON schema and reasoning disabled. |
|
Package graph normalizes and deduplicates code relations from parsed files into a clean dependency graph.
|
Package graph normalizes and deduplicates code relations from parsed files into a clean dependency graph. |
|
Package ingest orchestrates multi-source content ingestion into knowledge base topics, handling frontmatter assembly, raw file writes, and operation log entries.
|
Package ingest orchestrates multi-source content ingestion into knowledge base topics, handling frontmatter assembly, raw file writes, and operation log entries. |
|
Package instagram extracts captions and transcripts from Instagram video URLs (reels, video posts, and IGTV) by parsing Instagram URLs and delegating audio transcription to the shared mediadl core.
|
Package instagram extracts captions and transcripts from Instagram video URLs (reels, video posts, and IGTV) by parsing Instagram URLs and delegating audio transcription to the shared mediadl core. |
|
Package link relates a topic's documents to its wiki articles (spec §9): code proposes candidates (mentions, BM25, shared structure, optional semantic neighbours), the decision model judges one request per document, and code writes frontmatter relations and body links under write policy (d).
|
Package link relates a topic's documents to its wiki articles (spec §9): code proposes candidates (mentions, BM25, shared structure, optional semantic neighbours), the decision model judges one request per document, and code writes frontmatter relations and body links under write policy (d). |
|
Package lint checks knowledge base topics for structural issues such as missing frontmatter, broken wikilinks, and orphaned files.
|
Package lint checks knowledge base topics for structural issues such as missing frontmatter, broken wikilinks, and orphaned files. |
|
Package logger provides structured slog-based logging with configurable output and an observer pattern for log forwarding.
|
Package logger provides structured slog-based logging with configurable output and an observer pattern for log forwarding. |
|
Package mediadl extracts transcripts and metadata from media URLs (YouTube, Instagram, and other yt-dlp supported sources) and transcribes audio through an STT provider.
|
Package mediadl extracts transcripts and metadata from media URLs (YouTube, Instagram, and other yt-dlp supported sources) and transcribes audio through an STT provider. |
|
Package metrics computes file-level, symbol-level, and directory-level code metrics including complexity, coupling, blast radius, and code smell detection.
|
Package metrics computes file-level, symbol-level, and directory-level code metrics including complexity, coupling, blast radius, and code smell detection. |
|
Package migrate contains explicit vault layout migrations.
|
Package migrate contains explicit vault layout migrations. |
|
Package models defines shared domain types, interfaces, and snapshot structures used across the kb CLI.
|
Package models defines shared domain types, interfaces, and snapshot structures used across the kb CLI. |
|
Package okf implements Open Knowledge Format promotion and conformance checks.
|
Package okf implements Open Knowledge Format promotion and conformance checks. |
|
Package output renders structured data as table, JSON, or TSV for CLI display.
|
Package output renders structured data as table, JSON, or TSV for CLI display. |
|
Package qmd provides a shell-backed client for the QMD CLI.
|
Package qmd provides a shell-backed client for the QMD CLI. |
|
Package quality holds the code quality checks that run before any quality question (spec §7 stage 3): properties of the URL, the HTTP status, the title and the text length that code decides exactly and for free.
|
Package quality holds the code quality checks that run before any quality question (spec §7 stage 3): properties of the URL, the HTTP status, the title and the text length that code decides exactly and for free. |
|
Package questions loads the embedded, versioned question banks that kb asks the decision model, applies the guard prefix and hashes each bank so every decision can be replayed from its receipt.
|
Package questions loads the embedded, versioned question banks that kb asks the decision model, applies the guard prefix and hashes each bank so every decision can be replayed from its receipt. |
|
Package refs finds the inbound references to a topic document and moves a source into and out of quarantine without leaving dead links (spec §7.1).
|
Package refs finds the inbound references to a topic document and moves a source into and out of quarantine without leaving dead links (spec §7.1). |
|
Package resolve implements Obsidian-style link resolution for kb vaults and the link extraction shared by lint, refs and link: a target resolves by topic-relative path, topic-slug-prefixed path, vault-relative path, or file stem, case-insensitively.
|
Package resolve implements Obsidian-style link resolution for kb vaults and the link extraction shared by lint, refs and link: a target resolves by topic-relative path, topic-slug-prefixed path, vault-relative path, or file stem, case-insensitively. |
|
Package review owns a topic's review queue, its labels (human verdicts, including imported ones) and calibration with a holdout (spec §12).
|
Package review owns a topic's review queue, its labels (human verdicts, including imported ones) and calibration with a holdout (spec §12). |
|
Package scanner discovers source files in a workspace directory, respecting gitignore rules and custom include/exclude patterns.
|
Package scanner discovers source files in a workspace directory, respecting gitignore rules and custom include/exclude patterns. |
|
Package scope orchestrates the selection-contract workflow of `kb topic contract` (spec §5.1): drafting a contract with the generation model, importing one from the topic CLAUDE.md, the self-check of kept lines against out-of-scope lines, the impact preview (a shadow gate run of the draft over the topic's own sources) and activation after an explicit confirmation.
|
Package scope orchestrates the selection-contract workflow of `kb topic contract` (spec §5.1): drafting a contract with the generation model, importing one from the topic CLAUDE.md, the self-check of kept lines against out-of-scope lines, the impact preview (a shadow gate run of the draft over the topic's own sources) and activation after an explicit confirmation. |
|
Package session bundles everything one decision-backed kb run needs for a topic: resolved topic, topic.yaml settings and active contract, the decision engine and generation client sharing one budget and receipts log, the state store, the owned-key writer, a lazily loaded corpus, and the decision modes (body links, relevance gates, quality gates).
|
Package session bundles everything one decision-backed kb run needs for a topic: resolved topic, topic.yaml settings and active contract, the decision engine and generation client sharing one budget and receipts log, the state store, the owned-key writer, a lazily loaded corpus, and the decision modes (body links, relevance gates, quality gates). |
|
Package topic scaffolds, lists, and retrieves metadata for knowledge base topics within a vault.
|
Package topic scaffolds, lists, and retrieves metadata for knowledge base topics within a vault. |
|
Package vault provides path resolution, document rendering, reading, writing, and query helpers for Obsidian-compatible knowledge vaults.
|
Package vault provides path resolution, document rendering, reading, writing, and query helpers for Obsidian-compatible knowledge vaults. |
|
Package version exposes build metadata (version, commit, date) injected at compile time via ldflags.
|
Package version exposes build metadata (version, commit, date) injected at compile time via ldflags. |
|
Package youtube extracts transcripts and metadata from YouTube videos by parsing YouTube URLs and delegating extraction to the shared mediadl core.
|
Package youtube extracts transcripts and metadata from YouTube videos by parsing YouTube URLs and delegating extraction to the shared mediadl core. |
Click to show internal directories.
Click to hide internal directories.