Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .github/workflows/context-eval.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: context-eval

# Quality gate for `helpbase context`. Not per-PR (each run costs real
# Quality gate for `helpbase ingest` (the canonical name — the `context`
# alias is deprecated but still aliases here). Not per-PR (each run costs real
# LLM tokens against the AI Gateway). Two triggers:
#
# - workflow_dispatch: run on demand before a release or after a
Expand All @@ -19,7 +20,7 @@ on:

jobs:
eval:
name: helpbase context — 5-Q self-dogfood eval
name: helpbase ingest — 5-Q self-dogfood eval
runs-on: ubuntu-latest
timeout-minutes: 45
steps:
Expand All @@ -42,7 +43,7 @@ jobs:
- name: Build CLI
run: pnpm --filter helpbase build

- name: Run context eval (Sonnet 4.6)
- name: Run ingest eval (Sonnet 4.6)
env:
AI_GATEWAY_API_KEY: ${{ secrets.AI_GATEWAY_API_KEY }}
HELPBASE_EVAL_MODEL: anthropic/claude-sonnet-4.6
Expand Down
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Changed
- **`helpbase context` renamed to `helpbase ingest`.** `context` described
a domain concept, not an action — `ingest` names what the command does
(walk your code + markdown, synthesize cited how-tos, wire MCP). The
old name continues to work as a deprecation shim: same flags, same
behavior, one-line stderr warning, suppressed under `--json`/`--quiet`.
Help text + README Quick Start + scaffolder next-steps output now lead
with `ingest`. CI scripts pinned to `helpbase context` keep working
until v0.7, which is when the shim is removed. Flag surface is shared
via `applyIngestOptions()` so the two commands can't drift. First PR
of the CLI DX v2 plan.

### Added
- **Unit tests for the device-authorize state machine.** Extracted the
8-phase `Phase` union from `AuthorizeDeviceClient` into a pure
Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ monorepo.
- **Docs site** — a full Next.js + shadcn/ui help center in your repo
- **MCP server** — `@helpbase/mcp` runs next to your app, not in a vendor's cloud
- **`llms.txt` + `llms-full.txt`** — generated at your build time, served from your origin
- **`helpbase context`** — point at any repo, get cited how-to guides + MCP + llms.txt in one command
- **`helpbase ingest`** — point at any repo, get cited how-to guides + MCP + llms.txt in one command
- **Doc sync** — `helpbase sync` proposes codebase-grounded doc diffs with mandatory citations, opens them as PRs in your repo via your CI
- **Workflows** — `shadcn add helpbase-workflow` drops a plain GitHub Action that runs `helpbase sync` in your Actions minutes, with your secrets

Expand All @@ -60,16 +60,16 @@ log into.

## Quick start

Point `helpbase context` at any repo. Under 90 seconds from zero to
Point `helpbase ingest` at any repo. Under 90 seconds from zero to
generated docs. Works on macOS, Linux, and Windows. Requires Node 20+.

```bash
npx helpbase login # magic-link device flow, free 500k tokens/day, no card
npx helpbase context . # synthesize cited how-tos from your repo
npx helpbase context . --ask "how do I log in?" # answer in terminal, no MCP client required
npx helpbase ingest . # synthesize cited how-tos from your repo
npx helpbase ingest . --ask "how do I log in?" # answer in terminal, no MCP client required
```

`helpbase context` walks your code + markdown, synthesizes task-oriented
`helpbase ingest` walks your code + markdown, synthesizes task-oriented
how-to guides grounded in cited files, writes MDX to `.helpbase/docs/`,
and emits `llms.txt` + an MCP config hint. Same content, two surfaces:
humans read the MDX, agents query over MCP.
Expand Down Expand Up @@ -265,6 +265,7 @@ Edit, delete, or regenerate any of them. You own them.

```bash
helpbase dev # start the Next.js dev server
helpbase ingest [repo] # turn a repo into cited how-tos + llms.txt + MCP (.helpbase/)
helpbase generate --url <url> # generate articles from a URL
helpbase audit # validate frontmatter, categories, schema
helpbase new # create a new article from a template (interactive or --type/--title)
Expand Down
Loading
Loading