reqlanOverviewIdeasFilesCode filesClustersAttributesGraphPrint

Attribute detail

example

16 ideas · 16 distinct values

Ideas 16
Values 16

Value distribution

ValueDistributionIdeasShare
``` // After create-base, Explorer shows: reqlan-tutorials-demo/ .reqlan/ config.json .rqignore ideas-index.sqlite // appears once indexing activates — tooling memory reqs/ product.rq // Do not hand-edit ideas-index.sqlite. ``` 1 6.3%
``` // Five tiles — spoken map, not typed into the editor // 1. Language support → open when authoring or navigating .rq source // 2. Activity bar → open when the question is "what sits near this idea?" // 3. Ideas Summary → open when you need a catalog, table, or focused map // 4. Chat / skills / MCP / palette → open when running a focused graph operation // 5. Export / CLI → open when the graph must leave the editor ``` 1 6.3%
``` // Theme map — spoken over montage, not typed live // 01 imports/ideasets → split files, honest links // 02 attributes/plans → metadata that earns its keep // 03 Ideas Summary graph → cartographic cuts, not dumps // 04 context/tokens → compose slices, pin sparingly // 05 comment references → round-trip from code // 06 HTML export → graph leaves the editor // 07 CLI/MCP → same index, headless agents // 08 modelling patterns → habits that age well (+ non-software vignette) ``` 1 6.3%
```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 ``` 1 6.3%
```python print("hello") ``` 1 6.3%
```rq // Contrast slide only — not typed live in this episode // Left panel: chat paste (prose blob) // Right panel: the same intent as three named ideas login must reject empty passwords session expires after inactivity audit_log records failed attempts ``` 1 6.3%
```rq // reqs/auth.rq auth_core ( login_api, session_policy ) login_api { POST /login validates credentials and starts a session. Bound by [session_policy]. Implementation: ["./src/login.ts"] } session_policy { Sessions expire after thirty minutes of inactivity. } password_rules { Passwords must be at least twelve characters and reject empty submissions. } // reqs/product.rq — before fix: bare [login_api] fails or resolves ambiguously from "./auth.rq" import login_api import "./auth.rq" as auth welcome_flow { Success continues to [login_api]. Session rules live under [auth.session_policy]. Password policy: see [auth.password_rules]. } ``` 1 6.3%
```rq // reqs/auth.rq login_api { POST /login validates credentials and starts a session. Implementation: ["./src/login.ts"] Rejects empty passwords per [password_rules]. } ``` ```ts // src/login.ts export async function login(email: string, password: string) { if (!password) throw new Error("empty password"); } ``` 1 6.3%
```rq // reqs/auth.rq — one noun per beat in the recording fixture auth_core ( login_api, session_policy ) login_api { POST /login validates credentials and starts a session. Implementation: ["./src/login.ts"] Bound by [session_policy] and [password_rules]. @status in-progress @tags ( auth ) } session_policy { Sessions expire after thirty minutes of inactivity. } ``` 1 6.3%
```rq // Same product.rq as gs_03 — full fixture for reset product_name reqlan tutorials demo welcome_flow { New users land on a welcome screen with one primary action: create an account. Success continues into [onboarding_checklist]. } onboarding_checklist { After account creation, show three optional setup steps. Prefer [[welcome_flow|the welcome screen]] as the way back if they bail early. } account_model { Accounts need an email and a display name. Referenced by [welcome_flow] and [onboarding_checklist]. } ``` 1 6.3%
```rq password_rules { Passwords must be at least twelve characters and reject empty submissions. Empty submissions are a hard fail on [welcome_flow]. } ``` 1 6.3%
```rq product_name reqlan tutorials demo welcome_flow { New users land on a welcome screen with one primary action: create an account. Success continues into [onboarding_checklist]. } onboarding_checklist { After account creation, show three optional setup steps. Prefer [[welcome_flow|the welcome screen]] as the way back if they bail early. } ``` 1 6.3%
```rq product_name reqlan tutorials demo welcome_flow { New users land on a welcome screen with one primary action: create an account. } ``` 1 6.3%
from "@/path/relative/to/import/root.rq" import idea 1 6.3%
from "example.rq" import idea 1 6.3%
simple_idea, block_idea 1 6.3%

Ideas with this attribute

IdeaValueStatusTagsSummary
configuration_import_root_alias from "@/path/relative/to/import/root.rq" import idea An import path may start with an alias string, then `/`, then a relative path under that alias's import-root directory. Default alias string: `@`, written as `@/` plus a path relative to the import root. Default import-root directory: the workspace folder that contains the `.rq` file ( not the document directory ). The path after `/` is joined to that alias's import-root directory; the alias itself must be followed by `/` ( e. g. `@reqs` is not aliased ). Alias strings and import-root directories are configured as [configuration.configuration_import_roots] in the applying `.reqlan/config.json` from [configuration.configuration_location]. A configured relative `root` resolves against the base root ( parent of `.reqlan` ); an omitted `root` keeps the workspace-folder default. When several configured aliases could match a path, the longest alias wins. Related path forms: [import_paths]. Completion: ["../extension/syntax/features-syntax.rq".code_completion].
import_from from "example.rq" import idea From-import syntax uses from, a quoted path, import, and an idea name. From-import may include an alias using as.
code_snippets ```python print("hello") ``` Idea bodies and block attribute values may embed fenced code blocks delimited by triple backticks. An opening fence is three backticks on a line, optionally followed by a language tag such as python or rq. A closing fence is three backticks on a line. Everything between the fences is literal opaque text — it is not parsed as reqlan syntax. Keywords, imports, attributes, braces, and quotes inside a fence are inert for the parser and may be shown as examples without parse errors. Fenced blocks may span multiple lines and preserve their inner content verbatim. Brace-depth tracking must skip fence interiors so example braces cannot desync surrounding structure ( [no_name_idea_safe_warning] ).
ideaset simple_idea, block_idea An ideaset is a parenthesized, comma-separated list of idea names. Ideaset members may be unquoted identifiers or quoted strings. Ideasets act as namespace containers for ideas, nested ideasets, and references.
adv_01_imports_ideasets ```rq // reqs/auth.rq auth_core ( login_api, session_policy ) login_api { POST /login validates credentials and starts a session. Bound by [session_policy]. Implementation: ["./src/login.ts"] } session_policy { Sessions expire after thirty minutes of inactivity. } password_rules { Passwords must be at least twelve characters and reject empty submissions. } // reqs/product.rq — before fix: bare [login_api] fails or resolves ambiguously from "./auth.rq" import login_api import "./auth.rq" as auth welcome_flow { Success continues to [login_api]. Session rules live under [auth.session_policy]. Password policy: see [auth.password_rules]. } ``` Audience: builders with a single-file graph who feel reference sprawl or duplicate idea names across files. Outcome: split ideas across files; use `from` / `import` and namespace import; group with ideasets; resolve qualified references without breaking call-site readability. Runtime: 9 – 10 min. Demo: advanced baseline open on `reqs/product.rq`; `reqs/auth.rq` exists with `login_api` and `session_policy` but `product.rq` still references them without imports — caret on a broken or unresolved link. Related: [import_from] [import_namespace] [ideaset] [file] [reference]
adv_overview ``` // Theme map — spoken over montage, not typed live // 01 imports/ideasets → split files, honest links // 02 attributes/plans → metadata that earns its keep // 03 Ideas Summary graph → cartographic cuts, not dumps // 04 context/tokens → compose slices, pin sparingly // 05 comment references → round-trip from code // 06 HTML export → graph leaves the editor // 07 CLI/MCP → same index, headless agents // 08 modelling patterns → habits that age well (+ non-software vignette) ``` Audience: viewers who finished get-started and concepts ( or equivalent ) and want the map of craft themes before committing to a deep dive. Outcome: name the eight advanced themes, understand how they connect to get-started discipline, and pick a first episode. Runtime: 3 – 4 min. Demo: `reqlan-tutorials-demo` at advanced baseline — multi-file graph, `.reqlan` present, no new files typed; montage only. Related: [advanced_series_brief] [general_purpose] [llm_first] [concepts_series] [base] [multi_base_environment]
con_01_ontology ```rq // reqs/auth.rq — one noun per beat in the recording fixture auth_core ( login_api, session_policy ) login_api { POST /login validates credentials and starts a session. Implementation: ["./src/login.ts"] Bound by [session_policy] and [password_rules]. @status in-progress @tags ( auth ) } session_policy { Sessions expire after thirty minutes of inactivity. } ``` Audience: viewers who finished get-started ( or equivalent ) and want shared vocabulary without repeating the install loop. Outcome: define each core ontology noun in one sentence; place [base] as graph boundary ( including nesting ); distinguish [attribute_body] from optional `@` metadata; name [cartographic_map] as a chosen cut, not a mandatory dump. Runtime: 10 – 12 min. Demo: `reqlan-tutorials-demo` at get-started end state — `.reqlan/` present; `reqs/product.rq`, `reqs/auth.rq`, `src/login.ts`; caret starts on `welcome_flow` in `product.rq`. Related: [idea] [ideaset] [file] [base] [base_detail] [reference] [attribute] [attribute_body] [cartographic_map] [referenced_files] [configuration] [base_nesting] [multi_base_environment]
con_02_extension_tour ``` // Five tiles — spoken map, not typed into the editor // 1. Language support → open when authoring or navigating .rq source // 2. Activity bar → open when the question is "what sits near this idea?" // 3. Ideas Summary → open when you need a catalog, table, or focused map // 4. Chat / skills / MCP / palette → open when running a focused graph operation // 5. Export / CLI → open when the graph must leave the editor ``` Audience: viewers who know the ontology nouns and want a calm map of where they appear in the product. Outcome: name the primary [extension] surfaces and which job each owns; know where not to dig on day two. Runtime: 8 – 10 min. Demo: full get-started end state of `reqlan-tutorials-demo` ( `.reqlan`, `reqs/product.rq`, `reqs/auth.rq`, `src/login.ts` ); activity bar closed; Ideas Summary closed; chat available. Related: [extension] [activity_bar] [ideas_summary] [command_palette] [ai_integration] [html_export] [graph_view] [local_graph_view] [simple_views] [chat_skill_naming] [installation] [mcp_tools] [cli_package] [commands]
con_03_cli ```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 ``` 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]
gs_01_why_reqlan ```rq // Contrast slide only — not typed live in this episode // Left panel: chat paste (prose blob) // Right panel: the same intent as three named ideas login must reject empty passwords session expires after inactivity audit_log records failed attempts ``` Audience: developers or knowledge workers who already talk to LLMs about their project and feel context drift. Outcome: viewer can explain reqlan in one sentence and knows where install / docs live. Runtime: 4 – 5 min. Demo: cold open on a fresh machine or reset profile. Folder `reqlan-tutorials-demo` does not exist yet — or an empty folder with only `README.md`. No `.rq` files. reqlan extension not installed ( or disabled ) until the install beat. Related: [mission_statement] [llm_first] [inspiration] [installation_event] [installation] [extension_installation]
gs_02_first_idea ```rq product_name reqlan tutorials demo welcome_flow { New users land on a welcome screen with one primary action: create an account. } ``` Audience: freshly installed users who finished gs_01 or equivalent. Outcome: create a `.rq` file; write a one-liner and a block idea; save; see syntax highlighting and language mode. Runtime: 5 min. Demo: folder `reqlan-tutorials-demo` open in VS Code. Extension installed; onboarding seen once. Explorer shows empty tree or `README.md` only — no `reqs/` folder yet, no `.reqlan`. Related: [idea] [simple_idea] [block_idea] [simplicity] [file]
gs_03_link_ideas ```rq product_name reqlan tutorials demo welcome_flow { New users land on a welcome screen with one primary action: create an account. Success continues into [onboarding_checklist]. } onboarding_checklist { After account creation, show three optional setup steps. Prefer [[welcome_flow|the welcome screen]] as the way back if they bail early. } ``` Audience: users with at least one idea file from gs_02. Outcome: use bracket references and a wikilink; peek definition and go-to-definition; understand ideas as a navigable graph. Runtime: 6 min. Demo: `reqlan-tutorials-demo/reqs/product.rq` open. Caret inside `welcome_flow`. File contains `product_name` one-liner and `welcome_flow` block only — no links yet, no `account_model`, no `.reqlan`. Related: [reference] [reference_brackets] [reference_wikilink] [idea]
gs_04_first_base ``` // After create-base, Explorer shows: reqlan-tutorials-demo/ .reqlan/ config.json .rqignore ideas-index.sqlite // appears once indexing activates — tooling memory reqs/ product.rq // Do not hand-edit ideas-index.sqlite. ``` Audience: users with a small linked graph who have not yet marked a base. Outcome: create a [base] ( `.reqlan` ); explain that a base is the boundary of one ideas graph and owns the ideas index; know extension install ≠ base create. Runtime: 5 – 6 min. Demo: `reqlan-tutorials-demo` with `reqs/product.rq` containing linked `welcome_flow` ↔ `onboarding_checklist` ( and optional `account_model` ). No `.reqlan` folder. Activity bar or Ideas Summary shows empty / create-base prompt. Caret on any idea in `product.rq`. Related: [base] [base_detail] [create_base_onboarding] [base_installation] [installation] [extension_installation]
gs_05_activity_bar ```rq // Same product.rq as gs_03 — full fixture for reset product_name reqlan tutorials demo welcome_flow { New users land on a welcome screen with one primary action: create an account. Success continues into [onboarding_checklist]. } onboarding_checklist { After account creation, show three optional setup steps. Prefer [[welcome_flow|the welcome screen]] as the way back if they bail early. } account_model { Accounts need an email and a display name. Referenced by [welcome_flow] and [onboarding_checklist]. } ``` Audience: users with a small linked graph inside a [base]. Outcome: open the reqlan activity bar; follow editor focus with sync; adjust hop depth; copy a slice as markdown; glance at Ideas Summary without treating it as a full dump. Runtime: 6 – 7 min. Demo: `reqlan-tutorials-demo` is a [base] — `.reqlan/` present and index active. `reqs/product.rq` with linked `welcome_flow`, `onboarding_checklist`, optional `account_model`. Caret inside `welcome_flow`. Activity bar closed or on a non-reqlan view. Related: [activity_bar] [local_graph_view] [ideas_summary] [llm_first] [implied_context] [base]
gs_06_chat_search ```rq password_rules { Passwords must be at least twelve characters and reject empty submissions. Empty submissions are a hard fail on [welcome_flow]. } ``` Audience: users ready to involve AI without abandoning the graph. Outcome: invoke `@reqlan /rq-search` ( VS Code Chat ) or Cursor skill `rq-search`; find an idea by meaning; add to context; optionally build a requirement from intent. Runtime: 6 min. Demo: same base and `reqs/product.rq` as gs_05. Add `password_rules` if missing — otherwise type it live at cold open. No chat thread open yet. `.reqlan` index active. Related: [ai_integration] [chat_skill_naming] [ai_add_to_context] [ai_build_requirement] [mcp_tools] [command_palette]
gs_07_link_code ```rq // reqs/auth.rq login_api { POST /login validates credentials and starts a session. Implementation: ["./src/login.ts"] Rejects empty passwords per [password_rules]. } ``` ```ts // src/login.ts export async function login(email: string, password: string) { if (!password) throw new Error("empty password"); } ``` Audience: users with application source beside `reqs/` who completed gs_01 – 06. Outcome: add a file reference from an idea to implementation; open the file from the requirement; see reverse scope when standing in code; recap the get-started loop into Concepts. Runtime: 6 – 7 min. Demo: base active. `reqs/product.rq` with linked ideas and `password_rules`. No `reqs/auth.rq` yet. No `src/` folder. Caret in `product.rq`. Explorer shows only `reqs/` and `.reqlan/`. Related: [any_file_scope] [context_scope] [reference] [referenced_files] [file]