Документация BLXCode

Добро пожаловать в документацию BLXCode. Руководства пользователя объясняют, как запускать и использовать приложение; Руководства для разработчиков объясняют, как создавать, расширять и вносить свой вклад.

Опубликованная копия: GitHub Wiki (автоматически синхронизируется из этой папки при отправке main, касающейся docs/**). Редактируйте документацию здесь, в репозитории, а не в веб-интерфейсе вики.

Карта документа

Начните здесь: Начало работы → Рабочие пространства → Обвязка агента

Пользовательские документы

• Начало работы — предварительные условия, запуск BLXCode, первая рабочая область, в которой находятся данные, экран приветствия «Создание рабочей области», модель/группа усилий для каждого агента.
• Настройки — настройки прикрепленной центральной вкладки, Ключи API, Агент BLXCode (текст/изображение/голос), MCP, HeartBeat, Память, Редактор кода (Vim), Рабочая область, Внешний вид/темы, Справка/О программе, журнал приложений, Уведомления.
• Внешний вид и темы — выбор тем, предустановки, постоянство, исключения, размер шрифта.
• Рабочие пространства — создание, сетки терминалов, проводник боковой панели, разница файлов (этап/фиксация/отправка), график Git (извлечение/извлечение), передача обслуживания, сохранение, строка состояния приложения, перетаскивание контекста боковой панели (файлы/папки/разницы/фиксации), диалоговое окно установки перехватчика, именованные терминалы.
• Удаленный (SSH) — Настройки → Настройки удаленного подключения (пароль/ключ/агент, зашифрованные секреты), создание удаленных рабочих пространств, удаленные терминалы + файл/git + возобновление сеанса (tmux vs keepalive).
• Предварительный просмотр файла — предварительный просмотр изображений (включая SVG), видео, визуализированного Markdown, исходного кода с подсветкой синтаксиса и диаграмм Mermaid на центральной вкладке. Режим Vim через @replit/codemirror-vim. Документы по политике репозитория (LICENSE, CONTRIBUTING, SECURITY, CHANGELOG, …) отображаются как Markdown с героем баннера конкретного типа — с расширением .md или без него.
• Память и задачи — панель памяти (файлы, график, поиск), карта архитектуры, динамические категории, задачи, инструменты памяти агента, Индексатор памяти (HeartBeat), Панель настроек памяти.
• Планы — .agents/plans/<slug>/plan.md, автоматически поддерживаемый индекс PLANS.md, рабочая область Multi-Kanban, галерея диаграмм Mermaid, синтаксис задач, панель «Планы», инструменты агента.
• Правила и навыки — расширяемые карты правил/навыков, основные и пользовательские навыки, диалог установки.
• Agent Harness — основные навыки (включая MCP, генерацию подсказок), тонкую подсказку, среду/оболочку/git/web, ключи веб-API.
• Субагенты — параллельные запуски, роли, сроки, группы инструментов, ограничения.
• Сочетания клавиш — префикс tmux вместо устаревших аккордов, всплывающих уведомлений, Создать рабочую область, Push-to-Talk.
• Режим изображения — генерировать изображения из панели агента, настройки, лимиты, постоянство.
• Поставщики агентов — OpenRouter, Anthropic, OpenAI-совместимый + Ollama / LM Studio / Hugging Face / Cloudflare / Together / Portkey / custom, MCP-серверы, псевдоним агента, онбординг, виды контекста боковой панели.
• Голос — STT, TTS, микрофон, Push-to-Talk (локальный шепот/облако).
• Язык пользовательского интерфейса — локали, выбор языка, локализация EULA.
• Building — релизные сборки Linux, macOS, Windows.
• Устранение неполадок — проблемы с запуском, сборкой, браузером, связкой ключей, терминалом.

Документация разработчика

• Setup — команды локальной среды и проверки.
• Архитектура — разделение внешнего и внутреннего интерфейса, агент, память, планы, передача обслуживания, диаграммы, HeartBeat, Индексатор памяти, MCP, Kanban, Mermaid, Уведомления, Журнал приложений, Строка состояния приложения, Перетаскивание контекста боковой панели.
• Agent Harness — основные навыки (включая MCP, генерацию подсказок), отправку инструментов, веб-настройки, реестр текстовых поставщиков, модуль MCP, руководство по расширениям.
• Субагенты — subagents.run, бегун, протокол, группы инструментов, новые роли.
• Tauri IPC — регистрация команд, оболочки, группы команд, команды HeartBeat/Memory Indexer/MCP/Kanban/Mermaid/Notifications/App log.
• Удаленный транспорт SSH — терминалы в упаковке ssh, постоянный канал выполнения, удаленная маршрутизация fs/git, секреты, возобновление, удаление, отслеживание russh.
• Голосовая архитектура — модули и потоки STT/TTS.
• Интернационализация — локали, содержимое лицензионного соглашения, рабочий процесс перевода.
• Темы — токены, ThemeService, добавление тем, правила проверки.
• Contributing — стиль кода, правила, тестирование, контрольный список запросов на включение.

Принципы проекта

BLXCode — это локальная рабочая среда для настольных компьютеров. Рабочие области, терминалы, память, планы, задачи и контекст агента остаются близко друг к другу, не скрывая, где находятся данные на диске. Если поведение изменится, обновите документацию рядом с кодом, чтобы пользователи и участники могли двигаться дальше без необходимости реконструировать приложение.

Примечания к выпуску

Примечания для пользователей для каждой версии находятся в папке docs/releases/ (например, v0.5.0.md). В пререлизах также используется точное имя файла тега, например v0.5.1-pre.ed4dc.md. Они обеспечивают диалоговое окно Что нового в приложении после обновлений и должны оставаться нетехническими. Журнал технических изменений остается в CHANGELOG.md в корне репозитория.