Home

BLXCode Documentation

Welcome to the BLXCode docs. User guides explain how to run and use the app; developer guides explain how to build, extend, and contribute.

Published copy: GitHub Wiki (auto-synced from this folder on pushes to main that touch docs/**). Edit documentation here in the repository, not in the wiki web UI.

Doc map

Start here: Getting Started → Workspaces → Agent Harness

Topic	Guide
Settings (API Keys, BLXCode Agent, Workspace, Appearance / themes)	Settings · Appearance & Themes
Workbench, terminals, sidebar, handoff	Workspaces
File preview (images, video, Markdown, Mermaid)	File Preview
Memory, learnings, graph, categories	Memory And Tasks
Markdown plans and plan-linked tasks	Plans
Workspace rules and skills	Rules And Skills
Core skills, shell/git/web tools	Agent Harness
Coordinated subagents (scout/review/security)	Subagents
Tmux vs legacy shortcuts, notifications	Keyboard Shortcuts
Image generation mode	Image Mode
Providers, API keys, context, hooks	Agent Providers
Voice STT/TTS	Voice
UI language and EULA	UI Language
Build from source	Building
Common issues	Troubleshooting

User docs

• Getting Started — prerequisites, run BLXCode, first workspace, where data lives.
• Settings — docked center-tab settings, API Keys, BLXCode Agent grid, Workspace, Appearance / themes.
• Appearance & Themes — theme picker, presets, persistence, exceptions.
• Workspaces — creation, terminal grids, sidebar explorer, Git graph, handoff, persistence.
• File Preview — center-tab previews for images (incl. SVG), video, rendered Markdown, syntax-highlighted source code, and Mermaid diagrams. Repository policy docs (LICENSE, CONTRIBUTING, SECURITY, CHANGELOG, …) render as Markdown with a kind-specific hero banner — with or without a .md extension.
• Memory And Tasks — Memory panel (Files, Graph, Search), dynamic categories, tasks, agent memory tools.
• Plans — .agents/plans/, Kanban board, task syntax, Plans panel, agent tools.
• Rules And Skills — expandable rule/skill cards, core vs user skills, install dialog.
• Agent Harness — core skills, slim prompt, environment/shell/git/web, web API keys.
• Subagents — parallel runs, roles, timeline, tool groups, limits.
• Keyboard Shortcuts — tmux prefix vs legacy chords, notification toasts.
• Image Mode — generate images from the agent panel, settings, limits, persistence.
• Agent Providers — OpenRouter, Anthropic, OpenAI-compatible, context, hooks.
• Voice — STT, TTS, microphone, push-to-talk.
• UI Language — locales, language picker, EULA localization.
• Building — Linux, macOS, Windows release builds.
• Troubleshooting — startup, build, browser, keyring, terminal issues.

Developer docs

• Setup — local environment and verification commands.
• Architecture — frontend/backend split, agent, memory, plans, handoff, diagrams.
• Agent Harness — core skills, tool dispatch, web settings, extension guide.
• Subagents — subagents.run, runner, protocol, tool groups, new roles.
• Tauri IPC — command registration, wrappers, command groups.
• Voice Architecture — STT/TTS modules and flows.
• Internationalization — locales, EULA content, translation workflow.
• Themes — tokens, ThemeService, adding themes, lint rules.
• Contributing — code style, rules, testing, pull request checklist.

Project principles

BLXCode is a local-first desktop workbench. Workspaces, terminals, memory, plans, tasks, and agent context stay close together without hiding where data lives on disk. When behavior changes, update the docs beside the code so users and contributors can move forward without reverse-engineering the app.