Documentation

Référence CLI

Référence complète de chaque commande, option et mode de lecture de lean-ctx.

Ceci est la référence exhaustive de chaque commande lean-ctx. Pour un aide-mémoire rapide, consultez la Référence rapide. Pour les détails sur l'analytique et les tableaux de bord, consultez le Guide analytique.


Compression shell

Ces commandes exécutent des commandes shell à travers les plus de 95 motifs de compression de lean-ctx. La sortie est automatiquement débarrassée du bruit, du code répétitif et de la redondance avant d'atteindre le LLM.

lean-ctx -c "<command>"

Exécute n'importe quelle commande shell et compresse sa sortie. Alias : lean-ctx exec.

lean-ctx -c "git status"
lean-ctx -c "kubectl get pods -A"
lean-ctx -c "cargo build 2>&1"
lean-ctx exec "docker ps"

Le hook shell (installé via lean-ctx init) rend cela automatique pour les commandes courantes - vous n'avez pas besoin de les préfixer avec -c. Utilisez -c explicitement pour les commandes non couvertes par le hook shell.

lean-ctx shell

Démarre une session shell interactive où toute la sortie des commandes est compressée. Encapsule votre shell par défaut (zsh, bash ou fish).

lean-ctx shell
# Now every command output is compressed automatically
git log --oneline -20
docker compose logs
# Exit with Ctrl+D or 'exit'

Mode brut

Désactiver complètement la compression quand vous avez besoin de la sortie complète et non modifiée. Trois façons de l'activer :

# CLI flag
lean-ctx -c --raw git log --stat

# Shell function (after lean-ctx init --global)
lean-ctx-raw kubectl get pods -o yaml

# MCP parameter
ctx_shell(command="cat package.json", raw=true)

# Environment variable
LEAN_CTX_RAW=1 lean-ctx -c npm list

# Bypass command - guaranteed zero compression
lean-ctx bypass "git diff HEAD~1"

# Kill-switch: disable ALL compression
LEAN_CTX_DISABLED=1 lean-ctx -c git status

lean-ctx bypass "<command>"

Exécute n'importe quelle commande avec zéro compression garantie. Définit en interne LEAN_CTX_RAW=1 avant d'exécuter la commande. À utiliser quand vous avez besoin de la certitude absolue que la sortie n'est pas modifiée.

lean-ctx bypass "git diff HEAD~1"     # guaranteed unmodified output
lean-ctx bypass "docker logs myapp"   # no compression, no truncation
lean-ctx bypass "npm audit"           # raw vulnerability report

Conseil : bypass est équivalent à LEAN_CTX_RAW=1 lean-ctx -c "command" mais plus pratique. La chaîne de commande est passée directement au shell.


Opérations sur les fichiers

Accès CLI direct aux outils de lecture, recherche et navigation de fichiers de lean-ctx. Ce sont les mêmes opérations que le serveur MCP fournit aux outils IA.

lean-ctx read <file> [-m <mode>]

Lire un fichier avec un mode de compression optionnel. Le mode par défaut est full.

lean-ctx read src/main.rs                    # auto-selects best mode
lean-ctx read src/main.rs -m full            # full content (cached)
lean-ctx read src/main.rs -m map             # dependency graph + exports
lean-ctx read src/main.rs -m signatures      # tree-sitter AST extraction
lean-ctx read src/main.rs -m aggressive      # syntax-stripped
lean-ctx read src/main.rs -m entropy         # Shannon entropy filtered
lean-ctx read src/main.rs -m diff            # changed lines only
lean-ctx read src/main.rs -m task            # IB-filtered for current task
lean-ctx read src/main.rs -m reference       # cross-reference context
lean-ctx read src/main.rs -m lines:10-50     # specific line range
lean-ctx read src/main.rs -m lines:10-50,80  # multiple ranges

lean-ctx diff <file1> <file2>

Diff compressé entre deux fichiers avec résumés structurés des modifications.

lean-ctx diff old.rs new.rs

lean-ctx grep <pattern> [path]

Recherche dans le contenu des fichiers avec résultats compressés et regroupés. Utilise ripgrep en interne.

lean-ctx grep "pub fn" src/
lean-ctx grep "TODO" .
lean-ctx grep "async fn.*Result" rust/src/

lean-ctx find <pattern> [path]

Rechercher des fichiers par motif de nom. Respecte le .gitignore et produit une arborescence compacte.

lean-ctx find "*.rs" src/
lean-ctx find "test_*" .

lean-ctx ls [path]

Listing de répertoire compact sous forme d'arborescence avec comptage de fichiers.

lean-ctx ls
lean-ctx ls src/components/

lean-ctx deps [path]

Affiche le graphe de dépendances du projet. Détecte le gestionnaire de paquets et extrait les dépendances.

lean-ctx deps .
lean-ctx deps frontend/

Modes de lecture

Les modes de lecture contrôlent comment lean-ctx read et l'outil MCP ctx_read compressent le contenu des fichiers. Choisissez le bon mode pour votre cas d'usage :

ModeSortieCas d'usageSavings
autoMeilleur mode pour le contextePar defaut si aucun mode n’est specifie - lean-ctx choisit la strategie optimale60–95%
fullContenu complet du fichierFichiers que vous allez modifier. Les relectures coûtent ~13 tokens (en cache).0 % (première lecture), ~99 % (en cache)
mapGraphe de dépendances + exports + signatures clésFichiers de contexte uniquement - comprendre la structure sans tout lire.90–98%
signaturesExtraction AST via tree-sitter (18 langages)Surface API uniquement - signatures de fonctions/méthodes/classes.92–99%
aggressiveContenu sans syntaxeCompression maximale tout en préservant la logique.85–95%
entropyFiltrage par entropie de Shannon + JaccardConserver uniquement les lignes à haute densité d'information.70–90%
diffLignes modifiées uniquement (vs. dernière lecture)Après des modifications - voir uniquement ce qui a changé.90–99%
taskContenu filtre par tacheExtraction notee IB selon l’intention - uniquement le code pertinent pour la tache active70–90%
referenceContexte de reference croiseeTypes, appelants et dependances lies au symbole ou a la fonction cible60–85%
lines:N-MPlages de lignes spécifiquesLire uniquement la section dont vous avez besoin. Supporte les plages multiples : lines:10-50,80-100varies

Langages supportés pour le mode signatures : TypeScript, JavaScript, Rust, Python, Go, Java, C, C++, Ruby, C#, Kotlin, Swift, PHP (14 au total via tree-sitter).


Installation et configuration

lean-ctx setup

Configuration en une commande. Détecte automatiquement votre shell (zsh/bash/fish/PowerShell), trouve les outils IA installés et configure le serveur MCP + les hooks shell. À exécuter une seule fois après l'installation de lean-ctx.

lean-ctx setup

Cette commande exécute trois étapes en interne :

  1. Installe les alias shell (init --global)
  2. Configure MCP pour chaque outil IA détecté
  3. Vérifie que tout fonctionne (doctor)

Since v3.3.3, the setup wizard includes a Premium Features step where you can configure Terse Agent Mode, Tool Result Archive, and Output Density interactively.

lean-ctx init [--global | <shell>]

Installe les alias de compression shell dans votre profil shell.

# File-based: writes aliases directly into your shell profile
lean-ctx init           # install for current shell
lean-ctx init --global  # same, explicit flag

# Eval-based: prints hook code to stdout (like starship, zoxide, atuin)
eval "$(lean-ctx init bash)"        # bash: add to ~/.bashrc
eval "$(lean-ctx init zsh)"         # zsh: add to ~/.zshrc
lean-ctx init fish | source         # fish: add to config.fish
lean-ctx init powershell | Invoke-Expression  # PowerShell: add to $PROFILE

Cela écrit un bloc dans ~/.zshrc, ~/.bashrc, ~/.config/fish/config.fish ou votre profil PowerShell. Le bloc inclut les alias pour git, docker, npm, cargo et plus de 95 autres commandes.

Modèle eval : La méthode eval affiche le code hook sur stdout, garantissant qu'il correspond toujours à la version du binaire installé. C'est le même modèle utilisé par starship, zoxide et atuin. Les hooks ne sont jamais obsolètes après une mise à jour.

lean-ctx init --agent <name>

Configure MCP pour un outil IA spécifique sans exécuter le setup complet.

AgentNotes
cursorCursor IDE (default MCP setup)
claudeClaude Code / Claude Desktop
codexOpenAI Codex CLI
geminiGoogle Gemini CLI
antigravityAlias for gemini
windsurfWindsurf IDE
copilotGitHub Copilot
clineCline (VS Code extension)
rooRoo Code
aiderAider CLI
continueContinue.dev
zedZed Editor
voidVoid Editor
ampAmp (Sourcegraph)
traeTrae IDE
kiloKilo Code
opencodeOpenCode CLI
piInstalls pi-lean-ctx npm package
customGeneric MCP config - prompts for path
lean-ctx init --agent cursor
lean-ctx init --agent claude
lean-ctx init --agent codex
lean-ctx init --agent gemini
lean-ctx init --agent antigravity  # alias for gemini
lean-ctx init --agent windsurf
lean-ctx init --agent copilot
lean-ctx init --agent cline
lean-ctx init --agent roo
lean-ctx init --agent aider
lean-ctx init --agent continue
lean-ctx init --agent zed
lean-ctx init --agent void
lean-ctx init --agent amp
lean-ctx init --agent trae
lean-ctx init --agent kilo
lean-ctx init --agent opencode
lean-ctx init --agent pi           # installs pi-lean-ctx npm package
lean-ctx init --agent custom       # generic MCP config

lean-ctx config [set <key> <value>]

Afficher ou modifier la configuration stockée dans ~/.lean-ctx/config.toml.

lean-ctx config                        # show current config
lean-ctx config set ultra_compact true # enable ultra-compact mode
lean-ctx config set tee_on_error true  # log errors to ~/.lean-ctx/tee/
lean-ctx config set checkpoint_interval 20

Settable Configuration Keys

KeyTypeDefaultDescription
ultra_compactboolfalseEnable ultra-compact output mode for maximum token savings
tee_modestring"off"Tee logging mode: off, on_error, always
checkpoint_intervalint15Number of MCP calls between automatic checkpoints
themestring"default"Dashboard and TUI theme (default, dark, light, neon)
slow_command_threshold_msint5000Threshold in milliseconds for slow-log entries
passthrough_urlsstring[][]URL patterns that bypass compression (comma-separated)
rules_scopestring"project"Scope for rules loading: project, global, or both
lean-ctx config set theme neon
lean-ctx config set slow_command_threshold_ms 3000
lean-ctx config set passthrough_urls "localhost:3000,api.example.com"
lean-ctx config set rules_scope both

lean-ctx doctor

Exécute 8 diagnostics d'installation et d'environnement :

  • Binaire installé et dans le PATH
  • Hook shell actif
  • Config MCP pour les éditeurs détectés
  • Persistance du fichier de statistiques
  • Répertoire de cache
  • Shell supporté détecté
  • Détection d'outils IA
  • Vérification de version
  • Rules injection status
  • Claude Code instructions (rules + skill installed)
  • Build integrity verification
lean-ctx doctor

lean-ctx update [--check]

Mise à jour automatique du binaire lean-ctx depuis les GitHub Releases.

lean-ctx update         # download and install latest version
lean-ctx update --check # check if a newer version is available (no install)

lean-ctx login <email> [--password <pw>] v3.3.3

Authenticate with LeanCTX Cloud. Only attempts login - does not create a new account. If password is omitted, prompts interactively.

lean-ctx login user@example.com
lean-ctx login user@example.com --password mypassword

On success, saves the API key to ~/.lean-ctx/cloud/credentials.json and syncs your data. If your email is not yet verified, you'll receive a reminder to check your inbox.

lean-ctx register <email> [--password <pw>] v3.3.3

Create a new LeanCTX Cloud account. Separate from login - no auto-fallback. A verification email is sent after registration.

lean-ctx register user@example.com
lean-ctx register user@example.com --password mypassword

lean-ctx forgot-password <email>

Request a password reset email for an existing LeanCTX Cloud account.

lean-ctx forgot-password user@example.com

lean-ctx uninstall

Supprime toute la configuration de lean-ctx : hooks shell, configs MCP de tous les éditeurs et le répertoire de données ~/.lean-ctx/. Affiche les instructions pour supprimer le binaire.

lean-ctx uninstall

Analytique et tableaux de bord

Pour un guide détaillé avec captures d'écran et interprétations, consultez le Guide analytique.

lean-ctx gain [flags]

Tableau de bord visuel en terminal affichant les économies de tokens cumulées.

Propulse par GainEngine - une API d’observabilite unifiee qui regroupe metriques de compression, suivi des couts et analytics de session en un GainScore (0–100). Utilise ModelPricing embarque (sans reseau) et un TaskClassifier avec 13 categories.

OptionSortie
(none)Tableau de bord complet : total économisé, taux, USD, commandes les plus utilisées, sparklines
--scoreGainScore (0–100) combinant ratio de compression, efficacite des couts, qualite et coherence
--costDetail des couts par modele avec prix embarques (filtre --model=<name>)
--tasksRepartition des taches en 13 categories (file-ops, search, shell, memory, etc.)
--agentsStatistiques par agent en sessions multi-agents (appels, tokens, attribution des couts)
--heatmapHeatmap d’acces fichiers - quels fichiers l’IA lit le plus souvent
--wrappedResume style Spotify Wrapped (supporte --period=week|month|all)
--deepDeep-dive combine : rapport + taches + couts + agents + heatmap en une sortie
--liveMode rafraîchissement automatique (mise à jour toutes les 2 s). Appuyez sur q pour quitter.
--graphGraphique d'économies sur 30 jours avec barres quotidiennes
--dailyTableau jour par jour avec comptage de tokens et USD
--pipelinePipeline-view: shows compression stages and per-stage token savings
--jsonExport JSON brut de toutes les statistiques (pour le scripting/automatisation)

Modificateurs

OptionSortie
--model=<name>Filtrer cout/score sur un modele (ex. --model=claude-4-sonnet)
--period=<p>Fenetre de temps : today, week, month, all (defaut : all)
--limit=<n>Nombre max de lignes dans les tableaux classes (defaut : 10)
--resetEffacer toutes les stats et repartir a zero
lean-ctx gain                          # overview with GainScore
lean-ctx gain --score                  # GainScore breakdown
lean-ctx gain --cost --model=claude-4-sonnet  # cost for specific model
lean-ctx gain --tasks                  # task classification heatmap
lean-ctx gain --agents                 # multi-agent cost attribution
lean-ctx gain --deep                   # full deep-dive report
lean-ctx gain --wrapped --period=week  # weekly summary
lean-ctx gain --live                   # real-time monitoring
lean-ctx gain --graph                  # ASCII savings graph
lean-ctx gain --daily                  # daily breakdown
lean-ctx gain --pipeline               # per-stage compression breakdown
lean-ctx gain --json > stats.json      # machine-readable export

L’outil MCP ctx_gain fournit les memes analytics via API : les agents peuvent interroger economies de tokens, couts et GainScore pendant une session. Voir Reference des outils MCP.

lean-ctx cep [--json]

Rapport d'impact CEP (Cognitive Efficiency Protocol) montrant l'évolution des scores, les taux de hit du cache et la distribution des modes.

Internally uses ctx_gain --score to compute the Context Efficiency Protocol score. The CEP score ranges from 0–100 and measures how efficiently context is being utilized across read modes, shell compression, and deduplication.

FlagDescription
(none)Pretty-print CEP score with breakdown
--jsonMachine-readable JSON output
lean-ctx cep               # show CEP score with breakdown
lean-ctx cep --json        # JSON output for CI/CD integration

lean-ctx dashboard [--port=N] [--project=<path>]

Ouvre le tableau de bord web interactif sur http://localhost:3333. Comprend des graphiques interactifs, l'historique des sessions, les agents actifs et les panneaux de connaissances du projet.

FlagDescription
--port=<N>Custom port (default: 3333)
--project=<path>Scope dashboard to a specific project directory instead of the global view
lean-ctx dashboard                        # opens at localhost:3333
lean-ctx dashboard --port=8080            # custom port
lean-ctx dashboard --project=~/my-app     # scoped to a single project

lean-ctx wrapped [--week|--month|--all]

Génère un rapport « Wrapped » partageable de vos économies de tokens.

OptionPériode
(none)Semaine en cours
--weekSemaine en cours (explicite)
--monthMois en cours
--allStatistiques cumulées
lean-ctx wrapped
lean-ctx wrapped --month
lean-ctx wrapped --all

Gestion des sessions

lean-ctx sessions [list|show|cleanup]

Gérer les sessions CCP (Context Continuity Protocol) stockées dans ~/.lean-ctx/sessions/.

Sous-commandeAction
listLister toutes les sessions enregistrées
showAfficher l'état de la dernière session
cleanupSupprimer les sessions obsolètes
lean-ctx sessions list
lean-ctx sessions show
lean-ctx sessions cleanup

lean-ctx session

Affiche les statistiques d'adoption - quelle proportion de votre workflow utilise la compression lean-ctx.

lean-ctx session

Gestion des connaissances

Accès CLI complet au stockage de connaissances persistant du projet. Les faits, modèles et conventions survivent entre les sessions et permettent une compréhension cumulative du projet.

lean-ctx knowledge remember <value> --category <c> --key <k>

Stocke un fait dans la base de connaissances du projet avec un score de confiance optionnel.

lean-ctx knowledge remember "Uses JWT for auth" --category auth --key token-type
lean-ctx knowledge remember "PostgreSQL 16" --category arch --key database --confidence 0.95

lean-ctx knowledge recall [query] [--category <c>] [--mode auto|semantic|hybrid]

Récupère des faits par texte de requête ou catégorie. Supporte la récupération sémantique lorsque les embeddings sont activés.

lean-ctx knowledge recall "authentication"
lean-ctx knowledge recall --category security
lean-ctx knowledge recall "auth" --mode semantic

Recherche dans tous les projets et sessions les faits correspondants.

lean-ctx knowledge search "database migration"

lean-ctx knowledge export [--format json|jsonl|simple] [--output <path>]

Exporte la base de connaissances du projet. Sortie sur stdout par défaut (compatible avec les pipes). Trois formats : json (natif complet, par défaut), jsonl (un fait par ligne), simple (tableau compatible communauté pour la migration depuis d'autres outils).

lean-ctx knowledge export                                  # full JSON to stdout
lean-ctx knowledge export --format jsonl --output backup.jsonl  # JSONL to file
lean-ctx knowledge export --format simple | jq '.[].key'   # pipe-friendly

lean-ctx knowledge import <path> [--merge replace|append|skip-existing] [--dry-run]

Importe des faits depuis un fichier JSON, JSONL ou d'export natif. Détecte automatiquement le format d'entrée. La stratégie de fusion par défaut est skip-existing (sûre — n'écrase jamais).

lean-ctx knowledge import backup.json --dry-run             # preview changes
lean-ctx knowledge import facts.jsonl --merge replace        # overwrite existing
lean-ctx knowledge import migration.json --merge skip-existing

lean-ctx knowledge remove --category <c> --key <k>

Supprime un fait spécifique de la base de connaissances.

lean-ctx knowledge remove --category auth --key token-type

lean-ctx knowledge status

Affiche le résumé de la base de connaissances — nombre de faits, catégories et dernière mise à jour.

lean-ctx knowledge status

lean-ctx knowledge health

Rapport de santé avec métriques de qualité, détection des faits obsolètes et équilibre de l'espace.

lean-ctx knowledge health

Benchmarking

lean-ctx benchmark run [path] [--json]

Exécute de vrais benchmarks de tokens sur vos fichiers de projet avec tiktoken (o200k_base). Mesure les économies exactes pour chaque mode de lecture sur chaque fichier.

lean-ctx benchmark run                # benchmark current directory
lean-ctx benchmark run src/           # benchmark specific path
lean-ctx benchmark run . --json       # output as JSON

lean-ctx benchmark report [path]

Génère un rapport Markdown partageable à partir des résultats du benchmark.

lean-ctx benchmark report             # generate report for current directory
lean-ctx benchmark report src/ > BENCHMARK.md

Tee et filtres

lean-ctx tee [list|clear|show <file>|last]

Gérer les fichiers de sortie complète enregistrés dans ~/.lean-ctx/tee/. Utilisez lean-ctx tee last pour voir la dernière sortie enregistrée. Configurable via tee_mode : always, failures ou never.

lean-ctx filter [list|validate|init]

Gérer les filtres de compression personnalisés dans ~/.lean-ctx/filters/*.toml.

# Create example filter
lean-ctx filter init

# List loaded filters
lean-ctx filter list

# Validate filter syntax
lean-ctx filter validate

Utilitaires

lean-ctx discover

Analyse votre historique shell à la recherche de commandes qui pourraient bénéficier de la compression mais ne sont pas interceptées. Affiche les estimations de tokens par commande et la projection d'économies en USD.

lean-ctx discover

lean-ctx ghost [--json]

Reveals hidden token waste in your workflow - shows unoptimized shell commands, redundant reads, and oversized contexts with a monthly USD savings estimate. Use --json for CI integration.

lean-ctx ghost
lean-ctx ghost --json

lean-ctx cheatsheet

Affiche un aide-mémoire compact de toutes les commandes et workflows directement dans votre terminal.

lean-ctx cheatsheet

lean-ctx tee [list|clear|show <file>]

Gérer les fichiers de journaux d'erreurs stockés dans ~/.lean-ctx/tee/. Lorsque tee_on_error est activé dans la config, les commandes échouées enregistrent leur sortie complète ici.

Sous-commandeAction
listLister tous les fichiers de journaux d'erreurs
clearSupprimer tous les journaux d'erreurs
show <file>Afficher un journal d'erreurs spécifique
lean-ctx tee list
lean-ctx tee show 2026-03-29_10-30.log
lean-ctx tee clear

lean-ctx slow-log [list|clear]

Afficher ou vider le journal des commandes lentes dans ~/.lean-ctx/slow-commands.log. Les commandes plus longues que prévu y sont enregistrées pour le débogage.

lean-ctx slow-log list
lean-ctx slow-log clear

Graph du projet

Construire ou inspecter le dependency graph du projet. Le graph indexe les relations entre fichiers (imports, exports, symboles) et est utilisé pour le heat-ranking, l'analyse d'intention et le préchargement intelligent.

lean-ctx graph build

Scanner le répertoire du projet et construire l'index du dependency graph. Le graph est également construit automatiquement lors de l'utilisation des outils MCP.

lean-ctx graph build

Heat Map contextuelle

Visualiser la densité de token des fichiers et la connectivité du dependency graph sous forme de heat map colorée. Les fichiers avec un nombre élevé de token et de nombreuses connexions apparaissent plus chauds.

lean-ctx heatmap

Afficher une heat map terminale de tous les fichiers du projet en cours, triés par score de chaleur (combinaison du nombre de token et de la connectivité du graph).

lean-ctx heatmap

Niveaux de Sécurité

LeanCTX catégorise chaque commande prise en charge en un niveau de sécurité qui détermine l'agressivité de la compression. Les niveaux supérieurs ne suppriment jamais les informations critiques pour la sécurité (erreurs, CVEs, état de santé).

lean-ctx safety-levels

Affiche un tableau détaillé montrant exactement comment chaque type de commande est compressé, quelles données sont préservées et quelles fonctionnalités de sécurité globales sont actives.

lean-ctx safety-levels
NiveauCommandesComportement
VERBATIMdf, git status, git stash, ls, find, wc, envZéro compression. La sortie passe sans aucune modification.
MINIMALgit diff, git log, docker ps, grep, ruff, npm audit, pytest, pip, curlFormatage léger uniquement. Toutes les données critiques pour la sécurité (diffs de code, détails d'erreurs, IDs CVE, état de santé) sont entièrement préservées.
STANDARDcargo build, npm install, eslint, tsc, go build, maven, gradle, dotnetCompression structurée. Les erreurs, avertissements et éléments exploitables sont toujours préservés.
AGGRESSIVEkubectl describe, aws, terraform, docker imagesCompression forte pour les sorties verbeuses. Préserve toujours les messages d'erreur et les mots-clés critiques pour la sécurité.

Fonctionnalités de sécurité globales s'appliquent à TOUS les niveaux : analyse des aiguilles de sécurité (préserve CRITICAL, FATAL, panic, CVE-*, OOMKilled, etc.), ratio de protection (bloque la compression >95%), détection d'authentification (masque les tokens/mots de passe) et seuil minimum de tokens (pas de compression en dessous de 50 tokens).


Alias shell

Après avoir exécuté lean-ctx init --global, ces alias sont disponibles dans votre shell. Ils vous permettent d'activer ou désactiver la compression sans redémarrage :

AliasAction
lean-ctx-onActiver tous les alias de compression
lean-ctx-offDésactiver la compression (sortie lisible par l'humain)
lean-ctx-statusAfficher si la compression est actuellement active
lean-ctx-raw <cmd>Exécuter une seule commande sans compression
lean-ctx-status    # check current state
lean-ctx-off       # temporarily disable for human reading
git log            # now shows full, uncompressed output
lean-ctx-on        # re-enable for AI sessions

Quand désactiver : Désactivez la compression lorsque vous souhaitez lire vous-même la sortie des commandes (débogage, relecture des journaux). Réactivez-la avant de démarrer une session de codage avec l'IA.


Server & Services

lean-ctx can run as a long-lived HTTP server, a TUI watcher, or a network proxy. These modes are useful for CI/CD pipelines, multi-agent orchestration, and headless environments.

lean-ctx serve [flags] feature: http-server

Start an HTTP/REST server that exposes all MCP tools as REST endpoints. Requires the http-server feature gate. Supports both stateful (session-persisted) and stateless modes.

FlagDefaultDescription
--port=<N>9119Port to listen on
--host=<addr>127.0.0.1Bind address (0.0.0.0 for all interfaces)
--statelessoffDisable session persistence - each request is independent
--rate-limit=<N>100Max requests per minute per client
--timeout=<ms>30000Request timeout in milliseconds
--corsoffEnable CORS headers for browser access
# Start server with defaults
lean-ctx serve

# Public-facing with rate limits
lean-ctx serve --host=0.0.0.0 --port=8080 --rate-limit=50

# Stateless mode for CI/CD
lean-ctx serve --stateless --timeout=60000

# With CORS for web dashboard
lean-ctx serve --cors --port=9119

Once running, all MCP tools are available at POST /v1/tools/<tool_name>. A health endpoint is at GET /health.

lean-ctx watch

Start lean-ctx in TUI (Terminal UI) mode with a live event bus. Monitors all MCP activity in real time and writes events to ~/.lean-ctx/events.jsonl for post-hoc analysis.

FlagDescription
--filter=<pattern>Only show events matching the pattern (e.g. ctx_read, error)
--no-tuiHeadless mode - stream events to stdout as JSONL
lean-ctx watch                          # full TUI with live event stream
lean-ctx watch --filter=ctx_shell       # only shell events
lean-ctx watch --no-tui                 # headless JSONL to stdout

lean-ctx proxy <start|stop|status> feature-gated

Manage the lean-ctx network proxy. When active, the proxy intercepts MCP traffic and applies compression transparently. Requires the proxy feature gate.

SubcommandDescription
startStart the proxy daemon
stopStop the running proxy
statusShow proxy status (running/stopped, port, uptime)
lean-ctx proxy start       # start proxy daemon
lean-ctx proxy status      # check if proxy is running
lean-ctx proxy stop        # stop the proxy

Terse Agent

The Terse Agent controls output density for AI agent communication. It persists across sessions and can be toggled at any time. See also the Configuration guide.

lean-ctx terse [lite|full|ultra|off]

Query or set the Terse Agent mode. Without arguments, shows the current mode. With an argument, sets the mode persistently.

ModeDescription
offTerse Agent disabled - standard MCP output
liteLight compression: removes boilerplate, keeps structure
fullFull terse mode: abbreviated keys, minimal whitespace, Fn refs
ultraMaximum density: single-line responses, aggressive abbreviation, diff-only
lean-ctx terse              # show current terse mode
lean-ctx terse lite         # set to lite mode
lean-ctx terse full         # set to full mode
lean-ctx terse ultra        # maximum compression
lean-ctx terse off          # disable terse agent

Token Reports

Generate detailed token usage reports for analysis and cost tracking.

lean-ctx token-report [flags]

Display a comprehensive token usage report for the current or specified project. Also available as lean-ctx report-tokens (alias).

FlagDescription
(none)Summary report for the current session
--project=<path>Report for a specific project directory
--period=<p>Time period: today, week, month, all
--by-toolBreak down usage by MCP tool
--by-modeBreak down usage by read mode
--jsonMachine-readable JSON output
lean-ctx token-report                          # current session summary
lean-ctx token-report --period=week            # weekly report
lean-ctx token-report --by-tool --period=month # monthly per-tool breakdown
lean-ctx report-tokens --json > report.json    # alias, JSON export

Cache Management

Manage the lean-ctx content cache that accelerates repeated reads and avoids redundant compression.

lean-ctx cache <subcommand> [flags]

SubcommandDescription
statusShow cache size, hit rate, and entry count
clearClear all cached entries
invalidate <pattern>Invalidate cache entries matching a glob pattern
reset --project=<path>Reset cache for a specific project only
lean-ctx cache status                          # cache stats
lean-ctx cache clear                           # purge entire cache
lean-ctx cache invalidate "src/**/*.rs"        # invalidate Rust files
lean-ctx cache reset --project=~/my-app        # reset for one project

Gotchas

Manage known gotchas - common pitfalls, edge cases, and warnings that lean-ctx tracks across your projects. Also available as lean-ctx bugs (alias).

lean-ctx gotchas [list|add|remove|clear]

SubcommandDescription
listShow all tracked gotchas for the current project
add "<description>"Add a new gotcha entry
remove <id>Remove a gotcha by its ID
clearRemove all gotchas for the current project
lean-ctx gotchas list
lean-ctx gotchas add "ctx_shell timeout on M1 with Docker Rosetta"
lean-ctx gotchas remove 3
lean-ctx bugs list            # alias for gotchas list
lean-ctx bugs clear

Buddy

The Buddy (also called Pet) is an interactive companion feature that provides contextual tips, encouragement, and session insights. Purely cosmetic and opt-in.

lean-ctx buddy [status|on|off|name <name>]

SubcommandDescription
statusShow buddy status and current name
onEnable the buddy
offDisable the buddy
name <name>Give your buddy a custom name
lean-ctx buddy status          # check buddy state
lean-ctx buddy on              # enable buddy
lean-ctx buddy name Ferris     # name your buddy
lean-ctx pet off               # alias - disable buddy

Context Packages

Créez, gérez et partagez des context packages portables qui regroupent connaissances, données de graphe, découvertes de session et pièges dans des archives versionnées.

lean-ctx pack create --name <name> [--layers <layers>]

Create a context package from the current project. Layers default to all available (knowledge,graph,session,patterns,gotchas).

lean-ctx pack create --name my-pkg
lean-ctx pack create --name api-knowledge --layers knowledge,gotchas
lean-ctx pack create --name full-snapshot --version 2.0.0

lean-ctx pack list

List all installed packages with version and auto-load status.

lean-ctx pack list

lean-ctx pack info <name>

Show detailed metadata, layers, stats, and integrity hash for a package.

lean-ctx pack info my-pkg

lean-ctx pack export <name> [-o <file>]

Export a package to a portable .lctxpkg file. Default output is <name>.lctxpkg.

lean-ctx pack export my-pkg
lean-ctx pack export my-pkg -o shared/my-pkg.lctxpkg

lean-ctx pack import <file>

Import a package from a .lctxpkg file. Verifies SHA-256 integrity before installing.

lean-ctx pack import my-pkg.lctxpkg

lean-ctx pack install <name>

Merge a package's context into the current project — knowledge facts, graph nodes, and gotchas.

lean-ctx pack install my-pkg

lean-ctx pack remove <name>

Remove a package from the local registry.

lean-ctx pack remove my-pkg

lean-ctx pack auto-load <name> <on|off>

Enable or disable auto-loading. When enabled, the package is merged into the project context automatically when ctx_overview runs at session start.

lean-ctx pack auto-load my-pkg on
lean-ctx pack auto-load my-pkg off

Instructions

Manually retrieve MCP server instructions. Useful in headless or non-interactive environments where the MCP handshake does not automatically deliver instructions.

lean-ctx instructions [flags] v3.3.x

FlagDescription
(none)Print current MCP instructions to stdout
--rawOutput raw instruction text without formatting
--jsonOutput as JSON object with metadata
--injectInject instructions into the active agent session
lean-ctx instructions                   # print formatted instructions
lean-ctx instructions --raw             # raw text for piping
lean-ctx instructions --json            # JSON with metadata
lean-ctx instructions --inject          # inject into running session

This is particularly useful when integrating lean-ctx into CI/CD pipelines or custom agent frameworks that don't support the MCP instructions handshake natively.