Getting started

From install to first value in minutes.

Install the plugin, adopt a project, connect over MCP, and run your first workflow. Augment mode needs no key — add BYOK only when you orchestrate.

01

Install the plugin

Grab it from the VSCode/Cursor or JetBrains marketplace — or use the helixor CLI. serve runs the backend + MCP in one process; mcp-config prints your Cursor/Claude registration.

helixor serve helixor mcp-config
02

Adopt your project

Register the codebase and build the index. This is what turns grep-quality lookup into structural Code Indexes — definitions, usages, bonds, motifs.

helixor adopt .
03

Open the Helixor views

TODO Stacks and Code Indexes appear right in your IDE. Push a TODO from a selection; browse what the index knows.

04

Connect over MCP (augment · no key)

Register the MCP server into Claude Code or Codex. The agent brings its own model — no Helixor key required.

# paste the output of `helixor mcp-config` # into your agent's MCP settings
05

Try it

Run a Quality assessment, push a TODO from a selection, and watch the index answer better than grep — with fewer tokens.

06

Run your first workflow

List the catalog, then plan and start safe_change_delivery. Add your model keys (BYOK) so each step calls the right model, then act on the approval gate to continue.

workflow.run action=list workflow.run action=plan name=safe_change_delivery workflow.run action=start name=safe_change_delivery workflow.run action=act gate=approve
07

For teams: share a workspace

Host or join a shared workspace so stacks, indexes, and cross-agent channels are shared across the team via web admin.

helixor serve --host-workspace helixor serve --workspace-url https://…

Watch the menu bar

Run helixor up and look up-and-to-the-right.

A lightweight macOS companion appears in the menu bar. A green light means the local companion is healthy and your MCP endpoint is wired up — so you know the agent is connected before you dispatch it. Click it for index freshness, active TODO stacks, runtime connectivity, and a live tokens-consumed / tokens-saved meter. On headless Linux there's no tray — the same status is on the companion status API.

Helixor · healthy

Rule of thumb

Match the tool to the task.

One-off question

Just call search. Structural lookup answers better than grep — no ceremony.

Nontrivial change

Plan a design and a TODO stack so intent survives past the chat.

Risky / cross-repo

Run the full gated SDLC — human approval, evidence, and resumable checkpoints.

Platform onboarding

Request access to get set up.

Team is free. Self-serve isn't open yet — we'll onboard you.