Skip to content

Commit 07053cb

Browse files
riddim-developer-bot[bot]riddim-developer-bot
andauthored
[GRV-36]: Document human-handoff-linear (#53)
## Summary - Reposition `human-handoff-linear` in the root README as an independent local Linear workflow primitive with dry-run-first setup commands. - Rework the package README into a self-contained guide covering install, auth, `doctor`, `setup`, `sync-template`, and `bootstrap-project` usage. - Clarify current API-key local setup versus a future hosted OAuth / Linear Integration Directory app. - Add package keywords and strengthen CLI help smoke checks for README-referenced command and option output. ## Acceptance Criteria - Root README lists `human-handoff-linear` with value proposition and setup commands: done. - Package README documents install, auth, `doctor`, `sync-template`, `setup`, and `bootstrap-project`: done. - Docs explain API-key local setup versus future OAuth / Integration Directory app: done. - Docs include minimal Linear setup walkthrough and dry-run-first recommendation: done. - `package.json` metadata includes repository directory, license, engine, bin, files, and keywords: done. - Tests / smoke checks cover command help output referenced by docs: done. ## Verification - `npm --workspace human-handoff-linear test` - passed - `npm test` - passed - `git diff --check` - passed ## CLI Scorecard Surface: `human-handoff-linear` CLI help and documented command flow. Score: 86 / 100. Worst findings: - Long Linear API calls name their action and end with outcomes, but do not estimate rough duration for unusually slow workspaces. - There is no explicit TTY/non-TTY formatting branch beyond the absence of spinners/color and line-based output. - Help text is complete but dense; deeper examples live in README rather than inline help. Skipped checks: none. Co-authored-by: riddim-developer-bot <developer-bot@riddimsoftware.com>
1 parent 91eaa58 commit 07053cb

4 files changed

Lines changed: 182 additions & 143 deletions

File tree

README.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,23 +24,13 @@ npx linear-agent-hooks setup
2424

2525
### [`human-handoff-linear`](packages/human-handoff-linear)
2626

27-
Linear-backed workflow primitives for the human-handoff pattern — one project-level Human Handoff issue that aggregates every step a human still has to do in an otherwise autonomous flow.
28-
29-
Validate your Linear API key without touching any of your data:
30-
31-
```bash
32-
LINEAR_API_KEY=lin_api_… npx human-handoff-linear doctor
33-
```
34-
35-
Or provision the workspace-level `Human Handoff` issue template from the versioned, public-safe markdown body. Idempotent: creates the template the first time, updates it when the bundled body drifts, reports no-change when already in sync.
36-
37-
```bash
38-
LINEAR_API_KEY=lin_api_… npx human-handoff-linear sync-template
39-
```
40-
41-
Ensure selected Linear teams have the `human-handoff` issue label:
27+
Linear-backed workflow primitives for the human-handoff pattern: validate local
28+
API-key auth, install the team label, sync the workspace template, and
29+
bootstrap one project-level Human Handoff issue that aggregates human-only
30+
work. Start with a dry run before writing to Linear:
4231

4332
```bash
33+
npx human-handoff-linear setup --team GRV --dry-run
4434
npx human-handoff-linear setup --team GRV
4535
```
4636

0 commit comments

Comments
 (0)