BLXCode-Dokumentation

Willkommen bei den BLXCode-Dokumenten. Benutzerhandbücher erklären, wie die App ausgeführt und verwendet wird. In Entwicklerhandbüchern wird erklärt, wie man erstellt, erweitert und Beiträge leistet.

Veröffentlichte Kopie: GitHub Wiki (automatische Synchronisierung aus diesem Ordner bei Pushs an main, die docs/** berühren). Bearbeiten Sie die Dokumentation hier im Repository, nicht in der Wiki-Web-Benutzeroberfläche.

Doc-Karte

Hier beginnen: Erste Schritte → Arbeitsbereiche → Agent Harness

Benutzerdokumente

• Erste Schritte – Voraussetzungen, BLXCode ausführen, erster Arbeitsbereich, in dem sich die Daten befinden, Begrüßungsbildschirm Arbeitsbereich erstellen, Modell/Aufwandsflotte pro Agent.
• Einstellungen – angedockte Einstellungen auf der mittleren Registerkarte, API-Schlüssel, BLXCode-Agent (Text/Bild/Sprache), MCP, HeartBeat, Speicher, Code-Editor (Vim), Arbeitsbereich, Darstellung/Themen, Hilfe/Info, App-Protokoll, Benachrichtigungen.
• Darstellung und Themen – Themenauswahl, Voreinstellungen, Beständigkeit, Ausnahmen, Schriftgröße.
• Arbeitsbereiche – Erstellung, Terminalraster, Seitenleisten-Explorer, Dateivergleich (Stufe/Commit/Push), Git-Diagramm (Abrufen/Pull), Übergabe, Persistenz, App-Statuszeile, Kontext-Drag-and-Drop in der Seitenleiste (Dateien/Ordner/Unterschiede/Commits), Hook-Installationsdialog, benannte Terminals.
• Remote (SSH) – Einstellungen → Voreinstellungen für Remote-Verbindungen (Passwort/Schlüssel/Agent, verschlüsselte Geheimnisse), Remote-Arbeitsbereiche erstellen, Remote-Terminals + Datei/Git + Sitzungsfortsetzung (tmux vs. keepalive).
• Dateivorschau – Vorschau auf der mittleren Registerkarte für Bilder (einschließlich SVG), Videos, gerenderten Markdown, syntaxhervorgehobenen Quellcode und Mermaid-Diagramme. Vim-Modus über @replit/codemirror-vim. Repository-Richtliniendokumente (LICENSE, CONTRIBUTING, SECURITY, CHANGELOG, …) werden als Markdown mit einem typspezifischen Hero-Banner gerendert – mit oder ohne eine .md-Erweiterung.
• Speicher und Aufgaben – Speicherbereich (Dateien, Diagramm, Suche), Architekturkarte, dynamische Kategorien, Aufgaben, Agentenspeicher-Tools, Speicherindexer (HeartBeat), Bereich für Speichereinstellungen.
• Pläne – .agents/plans/<slug>/plan.md, automatisch verwalteter PLANS.md Index, Arbeitsbereich Multi-Kanban, Mermaid-Diagrammgalerie, Aufgabensyntax, Bedienfeld „Pläne“, Agententools.
• Regeln und Fertigkeiten – erweiterbare Regel-/Fähigkeitskarten, Kern- vs. Benutzerfertigkeiten, Installationsdialog. – Agent Harness – Kernkompetenzen (einschließlich MCP, Prompt-Generierung), schlanker Prompt, Umgebung/Shell/Git/Web, Web-API-Schlüssel.
• Subagents – parallele Ausführungen, Rollen, Zeitleiste, Toolgruppen, Grenzwerte.
• Tastaturkürzel – tmux-Präfix vs. Legacy-Akkorde, Benachrichtigungs-Toasts, Arbeitsbereich erstellen, Push-to-Talk.
• Bildmodus – Bilder aus dem Agentenfenster generieren, Einstellungen, Grenzwerte, Persistenz. – Agent-Anbieter – OpenRouter, Anthropic, OpenAI-kompatibel + Ollama / LM Studio / Hugging Face / Cloudflare / Together / Portkey / benutzerdefiniert, MCP-Server, Agent-Spitzname, Onboarding, Kontextarten in der Seitenleiste.
• Voice – STT, TTS, Mikrofon, Push-to-Talk (lokales Flüstern / Cloud).
• UI-Sprache – Gebietsschemas, Sprachauswahl, EULA-Lokalisierung.
• Building – Linux-, macOS- und Windows-Release-Builds.
• Fehlerbehebung – Start-, Build-, Browser-, Schlüsselbund- und Terminalprobleme.

Entwicklerdokumente

• Setup – lokale Umgebung und Verifizierungsbefehle.
• Architektur – Frontend-/Backend-Aufteilung, Agent, Speicher, Pläne, Übergabe, Diagramme, HeartBeat, Memory Indexer, MCP, Kanban, Mermaid, Benachrichtigungen, App-Protokoll, App-Statuszeile, Kontext-Drag-and-Drop in der Seitenleiste. – Agent Harness – Kernkompetenzen (einschließlich MCP, Prompt-Generierung), Tool-Versand, Webeinstellungen, Textanbieter-Registrierung, MCP-Modul, Erweiterungshandbuch. – Subagents – subagents.run, Runner, Protokoll, Toolgruppen, neue Rollen.
• Tauri IPC – Befehlsregistrierung, Wrapper, Befehlsgruppen, HeartBeat / Memory Indexer / MCP / Kanban / Mermaid / Notifications / App log Befehle. – SSH Remote Transport – Wrapped-ssh Terminals, persistenter Exec-Kanal, fs/git-Remote-Routing, Geheimnisse, Lebenslauf, Teardown, Rush-Follow-up. – Voice Architecture – STT/TTS-Module und -Flows.
• Internationalisierung – Gebietsschemas, EULA-Inhalte, Übersetzungsworkflow.
• Themen – Token, ThemeService, Themen hinzufügen, Lint-Regeln.
• Mitwirkend – Codestil, Regeln, Tests, Pull-Request-Checkliste.

Projektprinzipien

BLXCode ist eine Local-First-Desktop-Workbench. Arbeitsbereiche, Terminals, Speicher, Pläne, Aufgaben und Agentenkontext bleiben nah beieinander, ohne den Speicherort der Daten auf der Festplatte zu verbergen. Wenn sich das Verhalten ändert, aktualisieren Sie die Dokumente neben dem Code, damit Benutzer und Mitwirkende fortfahren können, ohne die App rückentwickeln zu müssen.

Versionshinweise

Benutzerbezogene Notizen für jede Version sind in docs/releases/ verfügbar (z. B. v0.5.0.md). Vorabversionen verwenden ebenfalls ihren genauen Tag-Dateinamen, z. B. v0.5.1-pre.ed4dc.md. Sie unterstützen den In-App-Dialog „Was ist neu?“ nach Aktualisierungen und sollten nicht technisch sein. Das technische Änderungsprotokoll verbleibt in CHANGELOG.md im Repository-Stammverzeichnis.