Dokumentacja BLXCode

Witamy w dokumentacji BLXCode. Podręczniki użytkownika wyjaśniają, jak uruchomić i korzystać z aplikacji; przewodniki dla programistów wyjaśniają, jak budować, rozszerzać i współtworzyć.

Opublikowana kopia: GitHub Wiki (automatyczna synchronizacja z tego folderu po wypchnięciu do main, które dotyka docs/**). Edytuj dokumentację tutaj, w repozytorium, a nie w interfejsie internetowym wiki.

Mapa dokumentu

Zacznij tutaj: Pierwsze kroki → Obszary robocze → Zespoły agentów

Dokumenty użytkownika

• Getting Started — wymagania wstępne, uruchom BLXCode, pierwszy obszar roboczy, w którym znajdują się dane, ekran powitalny Utwórz obszar roboczy, model dla poszczególnych agentów/flota wysiłku.
• Ustawienia — ustawienia zadokowanej środkowej karty, Klucze API, Agent BLXCode (tekst/obraz/głos), MCP, HeartBeat, Pamięć, Edytor kodu (Vim), Obszar roboczy, Wygląd / motywy, Pomoc/Informacje, Dziennik aplikacji, Powiadomienia.
• Wygląd i motywy — wybór motywów, ustawienia wstępne, trwałość, wyjątki, rozmiar czcionki.
• Obszary robocze — tworzenie, siatki terminali, eksplorator paska bocznego, porównywanie plików (etap/zatwierdzanie/push), wykres Git (pobieranie/ściąganie), przekazywanie, trwałość, linia stanu aplikacji, przeciąganie i upuszczanie kontekstu paska bocznego (pliki/foldery/różnice/zatwierdzenia), okno dialogowe instalacji haka, nazwane terminale.
• Remote (SSH) — Ustawienia → Ustawienia połączenia zdalnego (hasło / klucz / agent, szyfrowane sekrety), tworzenie zdalnych obszarów roboczych, zdalnych terminali + plik/git + wznawianie sesji (tmux vs keepalive).
• Podgląd pliku — podglądy na środkowej karcie obrazów (w tym SVG), wideo, renderowanego Markdown, kodu źródłowego z podświetloną składnią i diagramów syreny. Tryb Vima przez @replit/codemirror-vim. Dokumentacja zasad repozytorium (LICENSE, CONTRIBUTING, SECURITY, CHANGELOG, …) renderuje się jako Markdown z charakterystycznym dla danego rodzaju banerem bohatera — z rozszerzeniem .md lub bez.
• Pamięć i zadania — Panel pamięci (pliki, wykres, wyszukiwanie), mapa architektury, kategorie dynamiczne, zadania, narzędzia pamięci agenta, Indeksator pamięci (HeartBeat), Panel ustawień pamięci.
• Plany — .agents/plans/<slug>/plan.md, automatycznie utrzymywany indeks PLANS.md, Multi-Kanban obszaru roboczego, Galeria diagramów syreny, składnia zadań, panel Plany, narzędzia agenta.
• Zasady i umiejętności — rozwijalne karty zasad/umiejętności, umiejętności podstawowe i umiejętności użytkownika, okno dialogowe instalacji.
• Agent Harness — podstawowe umiejętności (w tym MCP, generowanie podpowiedzi), wąskie podpowiedzi, środowisko/powłoka/git/web, klucze web API.
• Subagents — przebiegi równoległe, role, oś czasu, grupy narzędzi, limity.
• Skróty klawiaturowe — przedrostek tmux w porównaniu ze starszymi akordami, wyskakujące powiadomienia, Utwórz obszar roboczy, Naciśnij i mów.
• Tryb obrazu — generuj obrazy z panelu agenta, ustawień, limitów, trwałości.
• Agent Providers — OpenRouter, Anthropic, zgodny z OpenAI + Ollama / LM Studio / Hugging Face / Cloudflare / Together / Portkey / niestandardowe, serwery MCP, pseudonim agenta, włączenie, rodzaje kontekstu paska bocznego.
• Głos — STT, TTS, mikrofon, Push-to-Talk (lokalny szept / chmura).
• Język interfejsu użytkownika — ustawienia regionalne, wybór języka, lokalizacja umowy EULA.
• Budynek — kompilacje wersji Linux, macOS i Windows.
• Rozwiązywanie problemów — problemy z uruchamianiem, kompilacją, przeglądarką, pękiem kluczy, terminalem.

Dokumentacja programisty

• Setup — środowisko lokalne i polecenia weryfikacyjne.
• Architektura — podział frontendu/backendu, agent, pamięć, plany, przekazanie, diagramy, HeartBeat, Memory Indexer, MCP, Kanban, Syrenka, Powiadomienia, Dziennik aplikacji, Linia stanu aplikacji, przeciąganie i upuszczanie kontekstu paska bocznego.
• Agent Harness — podstawowe umiejętności (w tym MCP, generowanie podpowiedzi), wysyłka narzędzi, ustawienia internetowe, rejestr dostawców tekstu, moduł MCP, przewodnik po rozszerzeniach.
• Subagents — subagents.run, biegacz, protokół, grupy narzędzi, nowe role.
• Tauri IPC — rejestracja poleceń, wrappery, grupy poleceń, polecenia HeartBeat / Memory Indexer / MCP / Kanban / Mermaid / Notifications / App log.
• Zdalny transport SSH — opakowane-ssh terminale, trwały kanał wykonawczy, zdalne routing fs/git, sekrety, wznawianie, porzucanie, śledzenie Rush.
• Architektura głosu — moduły i przepływy STT/TTS.
• Internacjonalizacja — ustawienia regionalne, treść umowy EULA, przepływ pracy z tłumaczeniem.
• Motywy — tokeny, ThemeService, dodawanie motywów, reguły lint.
• Contributing — styl kodu, reguły, testowanie, lista kontrolna żądania ściągnięcia.

Zasady projektu

BLXCode to lokalny pulpit roboczy. Obszary robocze, terminale, pamięć, plany, zadania i kontekst agenta pozostają blisko siebie, nie ukrywając miejsca przechowywania danych na dysku. Gdy zachowanie ulegnie zmianie, zaktualizuj dokumentację obok kodu, aby użytkownicy i współpracownicy mogli kontynuować pracę bez konieczności przeprowadzania inżynierii wstecznej aplikacji.

Informacje o wydaniu

Informacje dla użytkowników dotyczące każdej wersji są dostępne w docs/releases/ (na przykład v0.5.0.md). Wersje wstępne również używają dokładnej nazwy pliku znacznika, np. v0.5.1-pre.ed4dc.md. Obsługują okno dialogowe Co nowego w aplikacji po aktualizacjach i nie powinny mieć charakteru technicznego. Dziennik zmian technicznych pozostaje w CHANGELOG.md w katalogu głównym repozytorium.