Skip to content

Getting Started

  • Node.js 20+
  • gh CLI (authenticated) for GitHub sync
  • C/C++ build tools for better-sqlite3, or prebuilt binaries will be used automatically on supported platforms
Terminal window
npm install -g @mcptoolshop/repo-knowledge

Create a workspace config and seed the audit control catalog:

Terminal window
rk init

This creates rk.config.json in the current directory with default settings:

{
"owners": ["your-github-org"],
"localDirs": ["."],
"dbPath": "data/knowledge.db",
"artifactsRoot": "data/artifacts"
}

Pull repository metadata from GitHub:

Terminal window
rk sync --owners my-org

This fetches repo names, descriptions, topics, stars, languages, and license info via the gh CLI. No source code is read from GitHub.

To also scan local directories for tech fingerprints and docs:

Terminal window
rk sync --owners my-org --local /path/to/repos
Terminal window
# Check database statistics
rk stats
# Inspect a specific repo
rk show my-org/my-repo
# Search across everything
rk find "authentication"

All settings live in rk.config.json in your workspace root. Edit this file to change database path, GitHub owners, or local scan directories. See the Reference page for the full schema.