Documentação BLXCode

Bem-vindo à documentação do BLXCode. Os guias do usuário explicam como executar e usar o aplicativo; os guias do desenvolvedor explicam como construir, estender e contribuir.

Cópia publicada: GitHub Wiki (sincronizado automaticamente a partir desta pasta em envios para main que tocam em docs/**). Edite a documentação aqui no repositório, não na UI da web do wiki.

Mapa do documento

Comece aqui: Primeiros passos → Espaços de trabalho → Agente Harness

Documentos do usuário

• Introdução — pré-requisitos, execução do BLXCode, primeiro espaço de trabalho, onde os dados residem, tela de boas-vindas Criar espaço de trabalho, modelo por agente/frota de esforço.
• Configurações — configurações da guia central encaixada, Chaves de API, Agente BLXCode (texto/imagem/voz), MCP, HeartBeat, Memória, Editor de código (Vim), Espaço de trabalho, Aparência/temas, Ajuda/Sobre, Registro de aplicativos, Notificações.
• Aparência e temas — seletor de temas, predefinições, persistência, exceções, tamanho da fonte.
• Espaços de trabalho — criação, grades de terminal, explorador de barra lateral, comparação de arquivos (estágio/commit/push), gráfico Git (busca/pull), transferência, persistência, linha de status do aplicativo, arrastar e soltar do contexto da barra lateral (arquivos/pastas/diferenças/commits), caixa de diálogo de instalação do gancho, terminais nomeados.
• Remoto (SSH) — Configurações → Predefinições de conexão remota (senha/chave/agente, segredos criptografados), criação de espaços de trabalho remotos, terminais remotos + arquivo/git + currículo de sessão (tmux vs keepalive).
• Visualização do arquivo — visualizações na guia central para imagens (incl. SVG), vídeo, Markdown renderizado, código-fonte com destaque de sintaxe e diagramas Mermaid. Modo Vim via @replit/codemirror-vim. Documentos de política de repositório (LICENSE, CONTRIBUTING, SECURITY, CHANGELOG,…) são renderizados como Markdown com um banner de herói específico do tipo - com ou sem uma extensão .md.
• Memória e tarefas — Painel de memória (Arquivos, Gráfico, Pesquisa), mapa de arquitetura, categorias dinâmicas, tarefas, ferramentas de memória do agente, Indexador de memória (HeartBeat), Painel de configurações de memória.
• Planos — .agents/plans/<slug>/plan.md, índice PLANS.md mantido automaticamente, espaço de trabalho Multi-Kanban, Galeria de diagramas sereia, sintaxe de tarefa, painel Planos, ferramentas de agente.
• Regras e habilidades — cartões de regras/habilidades expansíveis, habilidades básicas versus habilidades do usuário, caixa de diálogo de instalação.
• Agent Harness — habilidades essenciais (incl. MCP, geração de prompt), prompt fino, ambiente/shell/git/web, chaves de API da web.
• Subagentes — execuções paralelas, funções, cronograma, grupos de ferramentas, limites.
• Atalhos de teclado — prefixo tmux vs acordes legados, brindes de notificação, Criar espaço de trabalho, Push-to-Talk.
• Modo de imagem — gera imagens do painel do agente, configurações, limites, persistência.
• Provedores de agentes — OpenRouter, Anthropic, compatível com OpenAI + Ollama / LM Studio / Hugging Face / Cloudflare / Together / Portkey / custom, servidores MCP, apelido do agente, onboarding, tipos de contexto da barra lateral.
• Voz — STT, TTS, microfone, Push-to-Talk (Sussurro local/nuvem).
• Idioma da UI — localidades, seletor de idioma, localização do EULA.
• Building — Compilações de lançamento para Linux, macOS e Windows.
• Solução de problemas — problemas de inicialização, compilação, navegador, chaveiro, terminal.

Documentos do desenvolvedor

• Setup — ambiente local e comandos de verificação.
• Arquitetura — divisão de frontend/backend, agente, memória, planos, transferência, diagramas, HeartBeat, Indexador de memória, MCP, Kanban, Sereia, Notificações, Registro do aplicativo, Linha de status do aplicativo, arrastar e soltar do contexto da barra lateral.
• Agent Harness — habilidades essenciais (incl. MCP, geração de prompts), envio de ferramentas, configurações da web, registro de provedor de texto, módulo MCP, guia de extensão.
• Subagentes — subagents.run, executor, protocolo, grupos de ferramentas, novas funções.
• Tauri IPC — registro de comandos, wrappers, grupos de comandos, comandos HeartBeat / Memory Indexer / MCP / Kanban / Mermaid / Notifications / App log.
• Transporte Remoto SSH — terminais encapsulados-ssh, canal exec persistente, roteamento remoto fs/git, segredos, currículo, desmontagem, acompanhamento rápido.
• Arquitetura de voz — Módulos e fluxos STT/TTS.
• Internacionalização — localidades, conteúdo do EULA, fluxo de trabalho de tradução.
• Temas — tokens, ThemeService, adição de temas, regras de lint.
• Contribuindo — estilo de código, regras, testes, lista de verificação de pull request.

Princípios do projeto

BLXCode é um ambiente de trabalho de desktop local. Espaços de trabalho, terminais, memória, planos, tarefas e contexto do agente permanecem próximos, sem ocultar onde os dados residem no disco. Quando o comportamento mudar, atualize os documentos ao lado do código para que os usuários e colaboradores possam seguir em frente sem fazer engenharia reversa do aplicativo.

Notas de lançamento

Notas voltadas ao usuário para cada versão estão disponíveis em docs/releases/ (por exemplo v0.5.0.md). Os pré-lançamentos também usam o nome exato do arquivo da tag, como v0.5.1-pre.ed4dc.md. Eles alimentam a caixa de diálogo Novidades no aplicativo após as atualizações e devem permanecer não técnicos. O changelog técnico permanece em CHANGELOG.md na raiz do repositório.