SuperKit

Documentation, tutorials, and recipes for SuperDB.

Website: chrismo.github.io/superkit

npm install -g @chrismo/superkit

• skdoc — Browse documentation (expert guide, upgrade guide, tutorials)
• skgrok — Search grok patterns
• skops — Browse recipe functions and operators

Also available via npx skdoc, npx skgrok, npx skops.

• Expert Guide — Comprehensive SuperSQL syntax reference
• Upgrade Guide — Migration guide from zq to SuperDB
• Tutorials — Step-by-step guides for common patterns
• Recipes — Reusable SuperSQL functions and operators
• Grok Patterns — All SuperDB grok patterns

The SuperDB MCP server depends on this package for its documentation tools. The TypeScript API is available for other integrations:

import { superHelp, superRecipes, superGrokPatterns } from '@chrismo/superkit';

The docs and recipes are tested against the SuperDB release pinned in .superdb-version:

npm ci
scripts/install-super.sh          # installs the pinned `super` to ~/.local/bin
npm test                          # recipe skdoc examples + parser checks
npm run test:docs                 # every mdtest example in docs/
npm run test:docs -- --skip lichess.org docs/tutorials   # options

CI runs all of this on every push and pull request.

To move to a new SuperDB release, bump .superdb-version, then fix whatever fails: the superdb_version front matter in each doc, super --version outputs, and any examples whose behavior changed.

If you previously installed SuperKit via the old install.sh script, remove the legacy files:

rm -f ~/.local/bin/sk ~/.local/bin/skdoc ~/.local/bin/skgrok \
      ~/.local/bin/skgrok.jsup ~/.local/bin/skops \
      ~/.local/bin/skops.jsup ~/.local/bin/skops.spq

SuperKit is licensed under the BSD-3-Clause License.

SuperKit is an independent project that documents and provides recipes for SuperDB, which is licensed under the SuperDB Source Available License. SuperKit does not distribute SuperDB source code or binaries.