Documentation BLXCode

Bienvenue dans la documentation BLXCode. Les guides d'utilisation expliquent comment exécuter et utiliser l'application ; les guides des développeurs expliquent comment créer, étendre et contribuer.

Copie publiée : GitHub Wiki (auto-synchronisée à partir de ce dossier lors des poussées vers main qui touchent docs/**). Modifiez la documentation ici dans le référentiel, pas dans l'interface utilisateur Web du wiki.

Carte du document

Commencez ici : Mise en route → Espaces de travail → Agent Harness

Documents utilisateur

• Mise en route — prérequis, exécutez BLXCode, premier espace de travail, où résident les données, écran de bienvenue Créer un espace de travail, modèle/flotte d'effort par agent.
• [Paramètres] (/docs/user/settings) — paramètres de l'onglet central ancré, Clés API, Agent BLXCode (texte/image/voix), MCP, HeartBeat, Mémoire, Éditeur de code (Vim), Espace de travail, Apparence/thèmes, Aide/À propos, Journal des applications, Notifications.
• Apparence et thèmes — sélecteur de thème, préréglages, persistance, exceptions, taille de police.
• Espaces de travail — création, grilles de terminaux, explorateur de la barre latérale, File Diff (stage/commit/push), graphique Git (fetch/pull), transfert, persistance, ligne d'état de l'application, glisser-déposer contextuel de la barre latérale (fichiers/dossiers/diffs/validations), boîte de dialogue d'installation du hook, terminaux nommés.
• Remote (SSH) — Paramètres → Préréglages de connexion à distance (mot de passe/clé/agent, secrets chiffrés), création d'espaces de travail distants, terminaux distants + fichier/git + reprise de session (tmux vs keepalive).
• Aperçu du fichier — aperçus dans l'onglet central des images (y compris SVG), de la vidéo, du rendu Markdown, du code source avec mise en évidence de la syntaxe et des diagrammes Mermaid. Mode Vim via @replit/codemirror-vim. Les documents de politique du référentiel (LICENSE, CONTRIBUTING, SECURITY, CHANGELOG, …) s'affichent sous forme de Markdown avec une bannière de héros spécifique au type – avec ou sans une extension .md.
• Mémoire et tâches — Panneau Mémoire (Fichiers, Graphique, Recherche), carte d'architecture, catégories dynamiques, tâches, outils de mémoire d'agent, Indexeur de mémoire (HeartBeat), Volet Paramètres de mémoire.
• Plans — .agents/plans/<slug>/plan.md, index PLANS.md auto-maintenu, espace de travail multi-Kanban, Galerie de diagrammes Sirène, syntaxe des tâches, panneau Plans, outils d'agent.
• Règles et compétences — cartes de règles/compétences extensibles, compétences de base par rapport aux compétences utilisateur, boîte de dialogue d'installation.
• Agent Harness — compétences de base (y compris MCP, prompt-generating), invite slim, environnement/shell/git/web, clés API Web.
• Subagents — exécutions parallèles, rôles, chronologie, groupes d'outils, limites.
• Raccourcis clavier — préfixe tmux par rapport aux accords hérités, toasts de notification, Créer un espace de travail, Push-to-Talk.
• Mode Image — génère des images à partir du panneau d'agent, des paramètres, des limites, de la persistance.
• Fournisseurs d'agents — OpenRouter, Anthropic, compatible OpenAI + Ollama / LM Studio / Hugging Face / Cloudflare / Together / Portkey / personnalisé, serveurs MCP, surnom d'agent, intégration, types de contexte de la barre latérale.
• Voix — STT, TTS, microphone, Push-to-Talk (Whisper local/cloud).
• Langue de l'interface utilisateur — paramètres régionaux, sélecteur de langue, localisation EULA.
• Building — Versions Linux, macOS et Windows.
• Dépannage — problèmes de démarrage, de build, de navigateur, de trousseau de clés, de terminal.

Documents du développeur

• Setup — environnement local et commandes de vérification.
• Architecture — répartition frontend/backend, agent, mémoire, plans, transfert, diagrammes, HeartBeat, Memory Indexer, MCP, Kanban, Mermaid, Notifications, Journal de l'application, Ligne d'état de l'application, glisser-déposer contextuel dans la barre latérale.
• Agent Harness — compétences de base (y compris MCP, génération d'invites), répartition des outils, paramètres Web, registre des fournisseurs de texte, module MCP, guide d'extension.
• Subagents — subagents.run, runner, protocole, groupes d'outils, nouveaux rôles.
• Tauri IPC — enregistrement des commandes, wrappers, groupes de commandes, commandes HeartBeat / Memory Indexer / MCP / Kanban / Mermaid / Notifications / App log.
• SSH Remote Transport — terminaux enveloppés-ssh, canal d'exécution persistant, routage à distance fs/git, secrets, reprise, démontage, suivi russe.
• Architecture vocale — Modules et flux STT/TTS.
• Internationalisation — paramètres régionaux, contenu CLUF, flux de travail de traduction.
• Themes — jetons, ThemeService, ajout de thèmes, règles de charpie.
• Contributing — style de code, règles, tests, liste de contrôle des pull request.

Principes du projet

BLXCode est un premier atelier de bureau local. Les espaces de travail, les terminaux, la mémoire, les plans, les tâches et le contexte de l'agent restent proches les uns des autres sans masquer l'emplacement des données sur le disque. Lorsque le comportement change, mettez à jour la documentation à côté du code afin que les utilisateurs et les contributeurs puissent avancer sans procéder à une ingénierie inverse de l'application.

Notes de version

Les notes destinées aux utilisateurs pour chaque version sont disponibles dans docs/releases/ (par exemple v0.5.0.md). Les avant-premières utilisent également leur nom de fichier de balise exact, tel que v0.5.1-pre.ed4dc.md. Ils alimentent la boîte de dialogue Quoi de neuf dans l'application après les mises à jour et doivent rester non techniques. Le journal des modifications techniques reste dans CHANGELOG.md à la racine du référentiel.