@fea17e86/kb
v1.0.0
Published
Portable Knowledge Base CLI
Readme
@fea17e86/kb
Portable Knowledge Base CLI. This toolkit can be dropped into any repository to provide a structured, agent-friendly knowledge base.
Installation
You can install this package globally or run it via npx in your repository.
Global Installation
npm install -g @fea17e86/kbLocal / Monorepo Installation
In a monorepo setup, it's typically managed as a workspace package. You can also run it directly without installing via npx:
npx @fea17e86/kb initCommands
kb init
Interactive wizard to bootstrap a repo. It writes the configuration file (knowledge-base.config.mjs), appends the activation snippet to AGENTS.md, and scaffolds the initial knowledge base files (KB-OVERVIEW.md, TERMS.md, REGISTRY.md).
kb migrate <path>
Process eligible documentation files (those with >100 lines and >1 H2 section) and create draft section files grouped under a new concern directory. This helps migrate existing flat documentation into the structured knowledge base format.
kb promote [path]
Promote draft section files to published status. It removes original source documents if they were migrated and automatically regenerates the TERMS.md index.
kb generate [--terms]
Rebuild the TERMS.md lookup index from all section file frontmatter. It scans all knowledge base directories for triggers and outputs the updated index.
kb validate
Runs a full suite of quality checks. It validates that all required frontmatter is present, ensures there are no generic trigger terms, limits trigger repetition, and checks for staleness.
kb stats
Generates a health report outlining the total number of section files, draft files, and coverage statistics.
