Get started

Install the editor extension. You can also install the CLI and the MCP server. All three use the same `.rq` files and the same `.reqlan` index.

Extension

Visual Studio Code with the official marketplace listing.

Open the Extensions view (Ctrl+Shift+X / Cmd+Shift+X).
Search for "reqlan" and install reqlan support.
Open a folder that contains `.rq` requirement files.
Try Reqlan: List All Ideas or hover an idea link for navigation.

Terminalcode --install-extension reqlan.reqlan-extension

CLI

@reqlan/cli

`@reqlan/cli` (`reqlan` / `rq`) searches, analyses, and exports the graph. It uses the same `.reqlan` index as the editor.

Installnpm install -g @reqlan/cli

Install `@reqlan/cli` (or run `npx @reqlan/cli`).
In a workspace, run `reqlan init` to create `.reqlan`.
Search or analyse the graph. Pass `--cwd` or set `REQLAN_WORKSPACE` if you are not in the workspace root.

Runreqlan init
Runreqlan search <query>
Runreqlan analyse [--file <path> | --idea <name>]
Runreqlan export html

Alias `rq` is the same binary.
Override index storage with `REQLAN_INDEX_PATH` when needed.

MCP

@reqlan/mcp

`@reqlan/mcp` is a stdio MCP server on that same index. No VS Code host is required.

Installnpx -y @reqlan/mcp

Add the server to your MCP client, or in Cursor run Reqlan: Install Cursor Skills after you install the extension.
Set `REQLAN_WORKSPACE` to the workspace root (or start the process from that directory).
Ask the agent to click an idea, file, or search phrase. Pass the returned sessionKey on the next click.

.cursor/mcp.json

{
  "mcpServers": {
    "reqlan": {
      "command": "npx",
      "args": ["-y", "@reqlan/mcp"],
      "env": {
        "REQLAN_WORKSPACE": "${workspaceFolder}"
      }
    }
  }
}

The retrieval tool is `click`. Status is `completion_status`.
Override index storage with `REQLAN_INDEX_PATH` when needed.

Extension

CLI

MCP

What's next

Keep going