The helpnest CLI reads your PRs, releases, code, and docs — then drafts customer-facing help articles and pushes them straight to your HelpNest workspace. Your Knowledge Base, populated in minutes.
# Seed an entire Knowledge Base from a GitHub repo
$npx helpnest seed \
--repo acme/my-app \
--token ghp_xxx \
--collection clx123abc \
--api-key hn_xxx
Collecting README sections...
Found 2 README sections
Collecting docs files...
Found 5 docs files
Collecting releases...
Found 10 releases
Collecting merged PRs...
Found 15 relevant PRs
Found 32 items: 2 readme, 5 docs, 10 releases, 15 prs
Generate 32 article(s)?[Y/n]y
[1/32]PR #87: Add webhook retries...Draft created: "Webhook retry and error handling"
[2/32]PR #91: Add SSO support...Draft created: "Setting up SSO"
[3/32] ... 30 more
Done:30 drafted, 2 skipped (duplicates)
How it works
No manual writing. No copy-pasting from changelogs.
Pulls from GitHub PRs, release notes, docs folders, READMEs, and your local codebase. You choose which sources to use.
A multi-round AI analysis identifies which files are relevant to each topic — not just by filename, but by reading the actual logic.
Generates clear, readable help articles written for your end users — not engineers. No code snippets, no jargon.
Articles land directly in your HelpNest workspace, ready to review and publish. Idempotent — re-running never creates duplicates.
Two commands
helpnest draftTwo modes: give it a PR title and body to document a specific change, or give it a plain topic and let it search your codebase for relevant context.
# Document a specific PR
$helpnest draft \
--pr-title "Add webhook retries" \
--collection clx123abc \
--api-key hn_xxx
helpnest seedRecommendedPoint it at a GitHub repo or local directory. It collects everything worth documenting and drafts articles in bulk — idempotent, so you can re-run anytime.
$helpnest seed \
--repo acme/my-app \
--source prs,releases,docs \
--from 2025-01-01 \
--api-key hn_xxx
Sources
The CLI understands the difference between things worth documenting for customers and things that aren't.
Every merged PR becomes a candidate for a help article. Low-signal PRs (chore, deps, bump) are filtered automatically.
Turn your GitHub releases into changelog-style articles. Filtered by date so you can catch up incrementally.
Ingests .md and .mdx files from your docs/ directory, one article per file.
Splits your README on H2 headings and turns each section into a focused help article.
AI maps your file tree into feature domains (Auth, Billing, Notifications…) and drafts one article per domain.
Give it a list of topics like 'SSO, password reset, API keys' and it drafts each one. Add --local to ground each article in your actual codebase.
Works everywhere
By default, the CLI points to helpnest.cloud. If you run your own HelpNest instance, pass --base-url to point it anywhere.
$helpnest seed \
--repo acme/my-app \
--base-url https://help.acme.com \
--api-key hn_xxx
Install the CLI, point it at your repo, and let it draft your first batch of articles. Free to use with any HelpNest instance.