Idea detail
con_03_cli
reqlan rq/marketing_and_media/tutorials.rq:1425
block
Summary
Audience: viewers who finished the extension tour and want the headless twin named — CI, scripts, and agents without living in the editor.
Outcome: install and run `reqlan` / `rq`; init a base; run search, analyse, and parse; know `--cwd` / `--json` and one-base-per-run; know export shares html_export with the extension.
Runtime: 9 – 11 min.
Demo: advanced get-started end state of `reqlan-tutorials-demo` — `.reqlan` indexed, `reqs/product.rq` + `reqs/auth.rq` present; integrated terminal at workspace root; extension idle in background ( not the focus ).
Related: cli_package commands init html_export base multi_base_environment llm_first function_parity
Attributes
| Key | Value |
|---|---|
| example | ```bash # From reqlan-tutorials-demo/ (active base at root) npx @reqlan/cli --help # or: npm i -g @reqlan/cli then: reqlan / rq npx reqlan init # same .reqlan marker as Create Base npx reqlan search "empty password" npx reqlan analyse --idea login_api npx reqlan parse reqs/auth.rq npx reqlan parse reqs/ --fail-on-diagnostics npx reqlan export --out ./docs-site # Wrong folder? pin the base: npx reqlan --cwd reqlan-tutorials-demo search "empty password" # Machines: add --json ``` |
| script | SCR: Title card — Concepts · 03 · CLI. Brand palette. Quiet terminal prompt at `reqlan-tutorials-demo`. VO: The extension tour named five surfaces. This pack is surface five up close — the cli_package binary `reqlan` (alias `rq`) on the same analytical core and `.reqlan` index. SCR: Terminal: `npx @reqlan/cli --help` — flash command list. Optional: mention global `npm i -g @reqlan/cli`. VO: Install is a package, not a Marketplace button. Use `npx` for a one-shot, or install globally when the terminal is your daily host. SCR: Explorer: `.reqlan/` already present from get-started. Brief beat — do not recreate live unless demo was reset. Optional alternate: empty sibling folder + `npx reqlan init` showing the marker appear. VO: init seeds the same `.reqlan` tree as Create Base in the editor. Extension install and base create stay separate layers — the CLI only owns the base marker path. SCR: `npx reqlan search "empty password"` — compact hits. Then `npx reqlan analyse --idea login_api`. VO: Search stays concise on purpose — same llm_first discipline as chat. Analyse expands one idea: references, files, attributes — not a whole-graph JSON dump unless you ask. SCR: `npx reqlan parse reqs/auth.rq` clean. Mention `parse reqs/ --fail-on-diagnostics` as the CI gate pattern. VO: Parse is how CI fails the build when requirements stop parsing — same sources the extension indexes. SCR: Ten-second export beat: `npx reqlan export --out ./docs-site` — same pipeline as the export form per html_export. VO: Export is one commands verb among equals. Form for exploration; CLI for scripts and pipelines. SCR: Slide: `--cwd` / `REQLAN_WORKSPACE`, `--json`, one active base per run. Explorer flash on nested-base dashed boundary — do not create one live. VO: Pin the workspace when the shell is in the wrong folder. Prefer `--json` for machines. Nested bases are separate runs — same craft as context and export in Advanced. SCR: Misconception beat — running from a parent monorepo without `--cwd`; results look empty or wrong. VO: If CLI and chat disagree, check cwd and active base first — not two different graphs. VO: Try this: from the demo root, run `npx reqlan parse reqs/ --fail-on-diagnostics` and imagine that line in CI. SCR: End card → Advanced overview. CTA from phonebook. |
| slides | { id title transition fade background brand-dark kicker Concepts · 03 heading CLI body Same graph API — terminal, scripts, and CI. asset logo notes The extension tour named five surfaces. This pack is surface five up close. }, { id install transition fade background brand-panel heading Install the binary body npx for a one-shot. Global install when the terminal is daily. code_lang bash code npx @reqlan/cli --help notes Binary names: reqlan and rq. Marketplace install is a different layer. }, { id init transition none background brand-contrast heading init = Create Base body Seeds the same .reqlan marker the editor uses. code_lang bash code npx reqlan init notes Extension install ≠ base create. CLI init only owns the marker path. }, { id search-analyse transition fade background brand-panel heading Search and analyse body Concise hits. One idea expanded — not a whole-graph dump. code_lang bash code npx reqlan search "empty password" / analyse --idea login_api notes Same llm-first discipline as chat search. }, { id parse-export transition fade background brand-panel heading Parse and export body Parse gates CI. Export shares the HTML pipeline with the extension form. code_lang bash code npx reqlan parse reqs/ --fail-on-diagnostics / export --out ./docs-site notes Form for exploration. CLI for scripts and pipelines. }, { id cwd-json transition none background brand-contrast heading Pin the base body --cwd / REQLAN_WORKSPACE. --json for machines. One base per run. code_lang bash code npx reqlan --cwd reqlan-tutorials-demo search "empty password" notes Nested bases are separate runs — not folders you merge by accident. }, { id wrong-folder transition fade background brand-panel heading Wrong folder trap body Empty or weird results? Fix cwd before blaming the graph. code_lang txt code CLI vs chat disagree → cwd or active base notes Two hosts, one analytical core. }, { id try-this transition fade background brand-dark heading Try this body Run parse on reqs/ with --fail-on-diagnostics — then picture that line in CI. fragments Next — Advanced overview notes Headless CI, local scripts, and the editor share one index under .reqlan. } |
Ancestor context
No ancestor chain recorded.
| Kind | Idea | Path | Snippet |
|---|---|---|---|
| None | |||
| Kind | Idea | Path | Snippet |
|---|---|---|---|
| ideaset_member | concepts_series | reqlan rq/marketing_and_media/tutorials.rq | — |
| ideaset_member | slide_decks | reqlan rq/marketing_and_media/tutorials.rq | — |
| references | advanced_series_brief | reqlan rq/marketing_and_media/tutorials.rq | con_03_cli |
| references | concepts_series_brief | reqlan rq/marketing_and_media/tutorials.rq | con_03_cli |
| references | demo_workspace | reqlan rq/marketing_and_media/tutorials.rq | con_03_cli |
| Kind | Idea | Path | Snippet |
|---|---|---|---|
| references | base | base | |
| references | cli_package | cli_package | |
| references | commands | commands | |
| references | function_parity | function_parity | |
| references | html_export | html_export | |
| references | init | init | |
| references | llm_first | llm_first | |
| references | multi_base_environment | multi_base_environment | |
| references | phonebook | phonebook |
Initialising graph…