One command for everything, or compose the pieces. All primitives are shadcn-native — the files land in your repo, you own them.
The full helpbase primitive in one command. Drops docs routes, starter MDX, the MCP server, and the citation-grounded sync workflow. Zero-config auth via GitHub OIDC.
When to use: You have an existing Next.js app and want helpbase working end-to-end. The homepage CTA runs this same command.
pnpm dlx helpbase initScaffold a fresh Next.js app with helpbase pre-installed. Good for new docs sites where you don't already have a repo.
When to use: You're starting from scratch and want the full help center as a standalone project.
pnpm dlx create-helpbasePrefer composability? Each piece stands alone. Install any subset; run helpbase init later to pull in the rest.
The docs UI primitive: routes, MDX pipeline, search, sidebar, TOC, and starter content. Everything you need for a shadcn-native help center, without the MCP server or CI workflow.
When to use: You want the docs site but not the AI/CI layers yet. You'll add those later, or you're integrating into an existing docs pipeline.
pnpm dlx shadcn@latest add https://helpbase.dev/r/help-center.jsonA single GitHub Actions file that opens a citation-grounded PR whenever code and docs drift. Zero config, zero secrets — auth via OIDC. Requires MDX already on disk.
When to use: Your repo already has docs (fumadocs, custom MDX, whatever) and you just want the CI loop that keeps them honest against code changes.
pnpm dlx shadcn@latest add https://helpbase.dev/r/helpbase-workflow.jsonA self-hosted Model Context Protocol server that exposes your docs to Claude, Cursor, Zed, and other AI agents. Runs from your repo, reads your MDX, serves over stdio.
When to use: Your docs already exist and you want to make them agent-readable without adding a docs UI or a CI workflow.
pnpm dlx shadcn@latest add https://helpbase.dev/r/helpbase-mcp.jsonPull individual pieces of the help center UI into a docs site you already have.
Cmd+K search dialog for help center articles. Keyboard-navigable with arrow keys. Pulls from your MDX at build time.
When to use: Add search to an existing docs site.
pnpm dlx shadcn@latest add https://helpbase.dev/r/help-center-search.jsonCollapsible docs sidebar with category icons, active indicators, and a mobile drawer. Reads from your content directory structure.
When to use: Replace your existing docs sidebar without rewriting your MDX pipeline.
pnpm dlx shadcn@latest add https://helpbase.dev/r/help-center-sidebar.jsonScroll-spy table of contents with a sliding active indicator. Clerk-style design.
When to use: Drop into any MDX page to give readers section navigation.
pnpm dlx shadcn@latest add https://helpbase.dev/r/help-center-toc.json