BLX코드 문서
BLXCode 문서 — BLXCode 문서.
BLXCode 문서에 오신 것을 환영합니다. 사용자 가이드에서는 앱 실행 및 사용 방법을 설명합니다. 개발자 가이드에서는 구축, 확장, 기여 방법을 설명합니다.
게시된 사본: GitHub Wiki(docs/**을 터치하는 main 푸시 시 이 폴더에서 자동 동기화됩니다.) Wiki 웹 UI가 아닌 저장소에서 문서를 편집하세요.
문서 지도
여기서 시작하세요: 시작하기 → 작업공간 → 에이전트 하네스
| 주제 | 가이드 |
|---|---|
| 설정(API 키, BLXCode Agent(텍스트/이미지/음성, MCP, HeartBeat, 메모리, 코드 편집기), 작업 공간, 모양/테마, 도움말/정보, 앱 로그) | 설정 · 모양 및 테마 |
| 워크벤치, 터미널, 사이드바, Git 차이점/동기화, 핸드오프, 앱 상태 줄, 사이드바 컨텍스트 드래그 앤 드롭 | 작업공간 |
| SSH를 통한 원격 작업 공간(연결, 터미널, 파일/git, 이력서) | 원격(SSH) |
| 파일 미리보기(이미지, 비디오, Markdown, Mermaid, Vim 모드) | 파일 미리보기 |
| 메모리, 학습, 아키텍처 맵, 그래프, Memory Indexer(HeartBeat), 메모리 설정 창 | 메모리 및 작업 |
| 마크다운 계획, 계획 연계 작업, 다중 칸반, 인어 다이어그램 갤러리 | 계획 |
| 작업 공간 규칙 및 기술 | 규칙 및 기술 |
| 핵심 기술(MCP, 프롬프트 생성 포함), 셸/git/웹 도구 | 에이전트 하네스 |
| 협력 하위 에이전트(스카우트/검토/보안) | 하위 에이전트 |
| Tmux와 기존 단축키 비교, Create Workspace, Push-to-Talk | 키보드 단축키 |
| 이미지 생성 모드 | 이미지 모드 |
| 공급자, API 키, 컨텍스트, 후크, MCP 서버, 에이전트 닉네임, 온보딩 | 에이전트 제공자 |
| 음성 STT/TTS, Push-to-Talk(로컬 귓속말/클라우드) | 음성 |
| UI 언어 및 EULA | UI 언어 |
| 소스에서 빌드 | 건물 |
| 일반적인 문제 | 문제 해결 |
사용자 문서
- 시작하기 — 전제 조건, BLXCode 실행, 데이터가 있는 첫 번째 작업 공간, 환영 화면 만들기 작업 공간, 에이전트별 모델/노력 플릿.
- 설정 — 도킹된 중앙 탭 설정, API 키, BLXCode 에이전트(텍스트/이미지/음성), MCP, HeartBeat, 메모리, 코드 편집기(Vim), 작업 공간, 모양/테마, 도움말/정보, 앱 로그, 알림.
- 모양 및 테마 — 테마 선택기, 사전 설정, 지속성, 예외, 글꼴 크기.
- 작업 공간 — 생성, 터미널 그리드, 사이드바 탐색기, 파일 차이(스테이지/커밋/푸시), Git 그래프(가져오기/풀), 핸드오프, 지속성, 앱 상태 줄, 사이드바 컨텍스트 드래그 앤 드롭(파일/폴더/차이/커밋), 후크 설치 대화상자, 명명된 터미널.
- 원격(SSH) — 설정 → 원격 연결 사전 설정(비밀번호/키/에이전트, 암호화된 비밀), 원격 작업 공간 생성, 원격 터미널 + 파일/git + 세션 재개(tmux 대 keepalive).
- 파일 미리보기 — 이미지(SVG 포함), 비디오, 렌더링된 마크다운, 구문 강조 소스 코드 및 인어 다이어그램에 대한 중앙 탭 미리보기입니다. Vim 모드
@replit/codemirror-vim을 통해. 리포지토리 정책 문서(LICENSE,CONTRIBUTING,SECURITY,CHANGELOG, …)는.md확장명 유무에 관계없이 종류별 히어로 배너를 사용하여 Markdown으로 렌더링됩니다. - 메모리 및 작업 — 메모리 패널(파일, 그래프, 검색), 아키텍처 맵, 동적 범주, 작업, 에이전트 메모리 도구, 메모리 인덱서(HeartBeat), 메모리 설정 창.
- 계획 —
.agents/plans/<slug>/plan.md, 자동 유지PLANS.md인덱스, 작업 공간 다중 칸반, 인어 다이어그램 갤러리, 작업 구문, 계획 패널, 에이전트 도구. - 규칙 및 스킬 — 확장 가능한 규칙/스킬 카드, 코어 대 사용자 스킬, 설치 대화상자.
- 에이전트 하네스 — 핵심 기술(MCP, 프롬프트 생성 포함), 슬림 프롬프트, 환경/셸/git/웹, 웹 API 키.
- 하위 에이전트 — 병렬 실행, 역할, 타임라인, 도구 그룹, 제한.
- 키보드 단축키 — tmux 접두사 대 레거시 코드, 알림 토스트, 작업 공간 만들기, Push-to-Talk.
- 이미지 모드 — 에이전트 패널, 설정, 제한, 지속성에서 이미지를 생성합니다.
- 에이전트 공급자 — OpenRouter, Anthropic, OpenAI 호환 + Ollama / LM Studio / Hugging Face / Cloudflare / Together / Portkey / custom, MCP 서버, 에이전트 닉네임, 온보딩, 사이드바 컨텍스트 종류.
- 음성 — STT, TTS, 마이크, Push-to-Talk(로컬 귓속말/클라우드).
- UI 언어 — 로케일, 언어 선택기, EULA 현지화.
- 빌딩 — Linux, macOS, Windows 릴리스 빌드.
- 문제 해결 — 시작, 빌드, 브라우저, 키링, 터미널 문제.
개발자 문서
- 설정 — 로컬 환경 및 확인 명령.
- 아키텍처 — 프런트엔드/백엔드 분할, 에이전트, 메모리, 계획, 핸드오프, 다이어그램, HeartBeat, Memory Indexer, MCP, Kanban, Mermaid, 알림, 앱 로그, 앱 상태 줄, 사이드바 컨텍스트 드래그 앤 드롭.
- 에이전트 하네스 — 핵심 기술(MCP, 프롬프트 생성 포함), 도구 디스패치, 웹 설정, 텍스트 제공자 레지스트리, MCP 모듈, 확장 가이드.
- 하위 에이전트 —
subagents.run, 러너, 프로토콜, 도구 그룹, 새로운 역할. - Tauri IPC — 명령 등록, 래퍼, 명령 그룹, HeartBeat / Memory Indexer / MCP / Kanban / Mermaid / 알림 / 앱 로그 명령.
- SSH 원격 전송 — Wrapped-
ssh터미널, 영구 실행 채널, fs/git 원격 라우팅, 비밀, 재개, 해제, russh 후속 조치. - 음성 아키텍처 — STT/TTS 모듈 및 흐름.
- 국제화 — 로캘, EULA 콘텐츠, 번역 작업 흐름.
- 테마 — 토큰,
ThemeService, 테마 추가, 린트 규칙. - 기여 — 코드 스타일, 규칙, 테스트, 풀 요청 체크리스트.
프로젝트 원칙
BLXCode는 로컬 우선 데스크탑 워크벤치입니다. 작업 공간, 터미널, 메모리, 계획, 작업 및 에이전트 컨텍스트는 디스크의 데이터 위치를 숨기지 않고 서로 가깝게 유지됩니다. 동작이 변경되면 사용자와 기여자가 앱을 리버스 엔지니어링하지 않고도 앞으로 나아갈 수 있도록 코드 옆에 있는 문서를 업데이트하세요.
출시 노트
각 버전에 대한 사용자용 메모는 docs/releases/(예: v0.5.0.md)에 게시되어 있습니다. 프리릴리즈에서는 v0.5.1-pre.ed4dc.md와 같은 정확한 태그 파일 이름도 사용합니다. 업데이트 후 인앱 새로운 기능 대화 상자를 지원하며 기술적이지 않은 상태를 유지해야 합니다. 기술 변경 로그는 저장소 루트의 CHANGELOG.md에 남아 있습니다.