BLXCode dokumentáció

Üdvözöljük a BLXCode dokumentumokban. A felhasználói útmutatók elmagyarázzák az alkalmazás futtatását és használatát; A fejlesztői útmutatók elmagyarázzák, hogyan kell építeni, bővíteni és hozzájárulni.

Közzétett példány: GitHub Wiki (automatikusan szinkronizálva ebből a mappából a main címre történő leküldéseknél, amelyek a docs/** elemet érintik). Szerkessze a dokumentációt itt a tárolóban, ne a wiki webes felhasználói felületén.

Doc térkép

Kezdje itt: Kezdő lépések → Workspaces → Agent Harness

Felhasználói dokumentumok

• Kezdő lépések – előfeltételek, futtassa a BLXCode-ot, az első munkaterületet, ahol az adatok élnek, üdvözlő képernyő Munkaterület létrehozása, ügynökönkénti modell/feladatflotta.
• [Beállítások] (/docs/user/settings) – dokkolt középső lapbeállítások, API-kulcsok, BLXCode-ügynök (szöveg/kép/hang), MCP, HeartBeat, memória, kódszerkesztő (Vim), munkaterület, megjelenés / témák, súgó/név, alkalmazásnapló, értesítések.
• Appearance & Themes – témaválasztó, előre beállított értékek, állandóság, kivételek, betűméret.
• Workspaces – létrehozás, terminálrácsok, oldalsáv-böngésző, Fájldiff (szakasz/commit/push), Git-gráf (lekérés/lehívás), átadás, megmaradás, alkalmazás állapotsora, oldalsáv kontextusának áthúzása (Fájlok/mappák/diffektusok)** install, **s.**d.**d.
• Távoli (SSH) — Beállítások → Távoli kapcsolat előre beállított beállításai (jelszó / kulcs / ügynök, titkosított titkok), távoli munkaterületek létrehozása, távoli terminálok + fájl/git + munkamenet folytatás (tmux vs keepalive).
• [Fájl előnézete] (/docs/user/file-preview) – képek (SVG-t is beleértve), videók, renderelt Markdown, szintaxis-kiemelt forráskód és Sellődiagramok középső fülön található előnézetei. Vim mód a @replit/codemirror-vim segítségével. A tárolóházirend-dokumentumok (LICENSE, CONTRIBUTING, SECURITY, CHANGELOG, …) Markdownként jelennek meg egy fajta-specifikus hős szalaghirdetéssel – .md kiterjesztéssel vagy anélkül.
• [Memória és feladatok] (/docs/user/memory-and-tasks) – Memóriapanel (Fájlok, Grafikonok, Keresés), architektúra térkép, dinamikus kategóriák, feladatok, ügynök memóriaeszközök, Memory Indexer (HeartBeat), Memóriabeállítások panel.
• Tervek — .agents/plans/<slug>/plan.md, automatikusan karbantartott PLANS.md index, munkaterület Multi-Kanban, Mermaid diagramgaléria, feladat szintaxisa, tervek panel, ügynöki eszközök.
• Rules And Skills – bővíthető szabály/készségkártyák, alapvető és felhasználói készségek, telepítési párbeszédpanel.
• Agent Harness – alapvető készségek (beleértve az MCP-t, prompt generálást), vékony prompt, környezet/shell/git/web, webes API-kulcsok.
• Subagents – párhuzamos futások, szerepek, idővonal, eszközcsoportok, korlátok.
• Billentyűparancsok – tmux előtag vs. régi akkordok, értesítési pohárköszöntők, Munkaterület létrehozása, Push-to-Talk.
• Image Mode – képeket generál az ügynökpanelről, beállításokat, korlátokat, állandóságot.
• Agent Providers — OpenRouter, Anthropic, OpenAI-kompatibilis + Ollama / LM Studio / Hugging Face / Cloudflare / Together / Portkey / egyéni, MCP-kiszolgálók, ügynök beceneve, beépítési, **oldalsáv-kontextustípusok
• Hang – STT, TTS, mikrofon, Push-to-Talk (helyi suttogás/felhő).
• UI Language – területi beállítások, nyelvválasztó, EULA lokalizáció.
• Building – Linux, macOS, Windows kiadású buildek.
• Hibaelhárítás – indítási, build, böngésző, kulcstartó, terminál problémák.

Fejlesztői dokumentumok

• Setup – helyi környezet és ellenőrző parancsok.
• Architektúra – frontend/backend felosztás, ügynök, memória, tervek, átadás, diagramok, HeartBeat, Memory Indexer, MCP, Kanban, Mermaid, Értesítések, Alkalmazásnapló-kontextussor**, **és-ppd
• Agent Harness – alapvető ismeretek (beleértve az MCP-t, prompt-generálást), eszközök feladása, webbeállítások, szövegszolgáltatói nyilvántartás, MCP-modul, bővítési útmutató.
• Subagents — subagents.run, futó, protokoll, eszközcsoportok, új szerepkörök.
• Tauri IPC – parancs regisztráció, burkolók, parancscsoportok, HeartBeat / Memory Indexer / MCP / Kanban / Mermaid / Notifications / App log parancsok.
• SSH Remote Transport – wrapped-ssh terminálok, állandó végrehajtási csatorna, fs/git távoli útválasztás, titkok, folytatás, lebontás, russh nyomon követés.
• Voice Architecture – STT/TTS modulok és folyamok.
• Nemzetközivé tétel – területi beállítások, EULA-tartalom, fordítási munkafolyamat.
• Témák – tokenek, ThemeService, témák hozzáadása, lintszabályok.
• Hozzájárulás – kódstílus, szabályok, tesztelés, lekérési ellenőrzőlista.

A projekt alapelvei

A BLXCode egy helyileg elsőként működő asztali munkaasztal. A munkaterületek, a terminálok, a memória, a tervek, a feladatok és az ügynökkontextus közel maradnak egymáshoz anélkül, hogy elrejtik az adatok helyét a lemezen. Amikor a viselkedés megváltozik, frissítse a kód melletti dokumentumokat, hogy a felhasználók és a közreműködők továbbléphessenek az alkalmazás visszafejtése nélkül.

Kiadási megjegyzések

Az egyes verziók felhasználóinak szóló megjegyzései a docs/releases/ mappában találhatók (például v0.5.0.md). Az előzetes kiadások pontos címkefájlnevüket is használják, például v0.5.1-pre.ed4dc.md. Ezek működtetik az alkalmazáson belüli Újdonságok párbeszédpanelt a frissítések után, és nem technikai jellegűek. A technikai változásnapló a CHANGELOG.md fájlban marad a lerakat gyökérjében.