Skip to content
Documentation

Get started

The commands you actually need.

A compact companion for reads, diagnosis, context recovery and session continuity.

AvailableReviewed September 2026

Inspect a project

lean-ctx ls .
lean-ctx grep "authenticate" src
lean-ctx read src/main.rs -m signatures
lean-ctx read src/main.rs -m full --fresh

Paths are examples. Run commands from the intended project root in PowerShell, Bash or zsh. For an npm installation on Windows, use lean-ctx.cmd as the command name. See platform conventions for quoting and paths, and read modes to choose a representation deliberately.

Use MCP tools

The blocks below are MCP calls, not shell commands. Supply the tool name and JSON arguments through your MCP client.

{"name":"ctx_compose","arguments":{"path":".","task":"Find where authentication is checked"}}
{"name":"ctx_search","arguments":{"action":"regex","path":".","pattern":"authenticate","max_results":12}}
{"name":"ctx_read","arguments":{"path":"src/main.rs","mode":"signatures"}}

If the host requires absolute paths, use the resolved project path. The tool reference gives exact parameter schemas.

Recover a missing detail

A signature is not an implementation. Request a focused line range or raw: true when you need exact file text. For archived command output, use the returned identifier with ctx_expand; for a cached source reference, use the documented recovery tool.

{"name":"ctx_read","arguments":{"path":"src/main.rs","raw":true}}

Recovery depends on retained content, source availability and access policy. Do not paste compressed omission markers back into source files.

Keep the next task informed

lean-ctx session task "Investigate authentication failures"
lean-ctx session finding "The login handler validates the session cookie"
lean-ctx session save
lean-ctx knowledge status

Record useful facts and their evidence, not secrets or whole transcripts. Review retained knowledge when the source changes.

Diagnose before changing settings

lean-ctx status
lean-ctx doctor
lean-ctx security status
lean-ctx config path
lean-ctx config validate

Open the local dashboard

lean-ctx dashboard

Run from your project and use the authenticated browser URL printed in the terminal. The dashboard guide covers views, editor integration, exports and troubleshooting. For services, profiles and logs, see local operation.

For the complete command surface, use CLI reference. Configuration, repair, update and uninstall commands can change local state; inspect their help before running them.

Sources & versions3 references Reviewed
Core checkout
0ce2207ee4
Installed runtime
3.10.2
SDK release
1.1.0

Separate baselines for source, CLI/configuration and SDK contracts. Review does not certify every platform or integration.

Versions & compatibility