Printable idea sheet
commands
reqlan rq/cli/cli_package.rq:46
Katz 0.760
Minimal commands:
- `parse <file>` — parse one `.rq` file via the core engine `parseReqlanSource` ( Rust `reqlan-parse` ); print diagnostics or an AST summary ( `--json` for machine output ).
- `analyse` / `analyze` — file ( `--file` ), idea ( `--idea` ), workspace completion ( default ),
local symbolic ( `--local-symbolic <file>`: outbound + same-file inbound, no index —
local_symbolic_analysis ),
or broken references ( `--broken-refs` ) via `AnalysisApi`.
`--glob` limits `--broken-refs` to a path subset of the base.
`--include-comments` adds unresolved comment_reference sites ( test_references ).
- `search <query>` — semantic search via `AnalysisApi.searchRequirements`.
Repeatable `--context <path|path#idea|name>` biases ranking by graph hop distance
( contextual_search ).
- `click <target>` — compact local context for an idea, `.rq` file, or indexed code file via `AnalysisApi.click`
( click ). No match uses search; more than one match is ranked by session distance.
Optional `--session` continues a click session. `--max-backlinks` / `--max-siblings` / `--max-outbound` / `--max-candidates` cap lists.
- `export` / `export html` — multi-file HTML site via `NativeAnalysisApi.exportHtml` ( html_export ).
`--exclude-secret` omits `*.secret.rq`.
`--exclude-ignored` omits paths matched by `.reqlan/.rqignore`.
`--url-base` mounts root-relative hrefs per html_export_url_base.
`--header-href` / `--header-label` set the topbar home link per html_export_header_link.
- `init directory` — create a new base marker ( `.reqlan` ) at the given path or cwd ( init ).
- `check` — CI wrapper around index unresolved references ( check ).
Reports broken idea, comment, file, and import references ( check_unresolved_imports ). Skips lines after comment_reference_ignore.
Repeatable `--glob <pattern>` limits the recursive scan to files that match any pattern
( check_glob_patterns ).
One `--glob` selects the same files as one path glob.
A positional file outside those patterns is checked as that file.
A positional directory outside those patterns is not walked.
`--json` / `--pipe` select machine output. Exit status is 1 when the command finds issues.
Issue order groups shared missing targets ( check_order_by_target ).
`--wildcard-zero` / `--wildcard-one` are `warn` ( default ), `error`, or `off`
( check_wildcard_zero, check_wildcard_one ).
Repeatable `--skip-target <glob>` omits issues whose missing target matches the glob
( check_skip_targets ).
`--skip-gitignored-targets` omits file-reference issues whose missing target is gitignored
( check_skip_gitignored_targets ).
- `barrel <file>` — split a large `.rq` page into one file per idea and a container import page ( barrel_page ).
- `diff <from> <to>` — compare ideas between two git revisions ( diff ).
No arguments compare pending `.rq` edits with `HEAD`, or `HEAD~1` with `HEAD` when those edits are absent.
`--verbosity` is `summary` ( default ), `references`, or `text`. `--json` prints the same rows as MCP.
Extra args from `pnpm run`: pnpm_extra_args.
Interactive page: commands