[ docs · getting started ]live

From zero to your first article in about ten minutes.

Two paths get you to the same place: a CLI mega-command that drives the whole pipeline end-to-end, or a six-step portal wizard that walks you through it. Both produce a real generated article on the other side.

Heads-up. The current public-beta flow expects your target application's repository to be accessible on the same machine that runs Quill (the local-path model). GitHub direct-connect — pick a repo from a list, Quill clones it — is the next milestone. The docs below cover the path that works today.
[ prerequisites ]

Before you start.

[ two paths ]

The CLI mega-command, or the portal wizard.

Path A · CLI mega-command

One command, end-to-end. Pick this if you'd rather watch a terminal than click through a wizard. Handles testid proposals, workspace init, the pipeline run, and category seeding.

Path B · Portal wizard

Six-step UI that runs the same operations behind the scenes, with previews at every step. Pick this if you want to inspect Quill's proposals before approving them.

[ path a — cli ]

Mega-command, end-to-end.

One invocation. testids → init → pipeline → categorize. Drop a relative or absolute path to your repo on disk.

$ quill onboard ./path/to/your-app

Want a dry-run first? Add --dry-run — Quill prints every action it would take without writing to disk.

$ quill onboard ./your-app --dry-run
[ path b — portal ]

The six-step wizard.

Same operations as the CLI, surfaced as a Linear-style wizard. Each step previews its proposals before you approve.

1

Welcome.

Confirm prerequisites and pick the brand presets that'll apply to every generated article. Defaults are sensible — you can override later from Settings → Branding.

2

Connect repo.

Point Quill at the absolute path to your application on this machine. We validate it's a recognized framework (Next.js, Remix, etc.) before letting you continue.

3

Customer-auth setup.

Tell Quill how to log in to your app — form fields, dev credentials, or skip if your app has a public surface to document. The runner uses this to reach authed routes.

4

Discover features.

Quill scans your routes and components, proposes a feature catalog, and shows you the diff. You approve the features that should ship articles; the rest stay off the queue.

5

Stable selectors.

Quill proposes data-testid attributes for interactive elements that lack them. Review and apply in-place — the runner depends on stable selectors, never on CSS classes or text content.

6

First run.

Quill executes the pipeline against your selected features. Live progress streams in the portal. When it lands, you've got a real article queued for review.

[ what's next ]

After the first run.

Set up the listen-to-main loop

Quill re-runs the relevant slice of the pipeline whenever main changes. For self-serve, run quill from a CI step on push to main; the queue picks up the deltas.

Review the queue

Open the portal → Articles. Each draft has a side-by-side preview, regenerate button, and a per-step diff against the source. Approve, edit, or reject.

Browse the CLI

The mega-command is one of seven CLI subcommands. The CLI reference breaks each one down with examples.

Ten minutes to a first article.

Spin up a workspace from the portal and we'll walk you through it, step by step.