CodeBoarding/CodeBoarding

AI가 코드를 망가뜨리기 전에 무엇을 구축하고 있는지 확인하세요.

CodeBoarding은 개발자와 코딩 에이전트 (coding agents)에게 코드베이스 (codebase)의 시각적 지도를 제공합니다. 정적 분석 (static analysis)과 LLM 추론 (reasoning)을 결합하여 아키텍처 다이어그램 (architecture diagrams), 컴포넌트 수준의 문서 (component-level documentation), 그리고 IDE, CI, 문서에서 사용할 수 있는 탐색 가능한 출력물을 생성합니다.

Website · Open VSX extension · Explore examples · VS Code extension · GitHub Action · Discord

Open VSX에서 확장을 설치하세요.

• 에이전트가 코딩하는 동안 아키텍처를 계속 시각화하여 유지합니다.

• AI가 생성한 변경 사항이 숨겨진 기술 부채 (hidden debt)가 되기 전에 시스템 컨텍스트 (system context)와 함께 검토합니다.

• 계층형 다이어그램 (layered diagrams)과 컴포넌트 분해 (component breakdowns)를 통해 대규모 저장소 (repositories)를 더 빠르게 이해합니다.

• 로컬 워크플로 (local workflows), IDE, 풀 리퀘스트 (pull requests), 문서 전반에 걸쳐 동일한 시각적 모델을 공유합니다.

• 상위 수준의 시스템 아키텍처 다이어그램 (High-level system architecture diagrams).

• 중요한 서브시스템 (subsystems)을 위한 더 깊은 컴포넌트 다이어그램 (component diagrams).

• .codeboarding/ 내의 Markdown 문서.

• 문서 및 PR에 삽입하기 쉬운 Mermaid 출력물.

• 코드베이스의 일부만 변경될 때의 증분 업데이트 (Incremental updates).

graph LR
Application_Orchestrator_Repository_Manager["Application Orchestrator & Repository Manager"]
LLM_Agent_Core["LLM Agent Core"]
...

더 자세한 아키텍처 워크스루 (walkthrough)를 보려면 .codeboarding/overview.md를 참조하세요.

.

uv sync --frozen
source .venv/bin/activate # On Windows: .venv\Scripts\activate
python install.py
...

Python 3.12 또는 3.13이 필요합니다. 권장되는 설치 방법은 CLI를 자체 격리된 환경에 유지하는 pipx입니다:

pipx install codeboarding --python python3.12
codeboarding-setup
codeboarding full --local /path/to/repo

또는 pip를 선호하는 경우, 가상 환경 (virtual environment)에 설치하세요 (전역 Python이 아님):

pip install codeboarding
codeboarding-setup
codeboarding full --local /path/to/repo

출력물은 /path/to/repo/.codeboarding/에 작성됩니다.

.

python install.py와 codeboarding-setup은 언어 서버 바이너리 (language server binaries)를 프로젝트 간에 공유되는 ~/.codeboarding/servers/로 다운로드합니다. Node.js (및 내장된 npm...

)는 Python, TypeScript, JavaScript, 그리고 PHP 언어 서버 (language servers)를 위해 필요합니다. node나 CODEBOARDING_NODE_PATH가 설정되어 있지 않으면, setup 과정에서 고정된 (pinned) Node.js 런타임을 ~/.codeboarding/servers/nodeenv/에 자동으로 다운로드합니다.

처음 실행할 때, CodeBoarding은 ~/.codeboarding/config.toml을 생성합니다. 그곳에서 하나의 제공자 (provider)를 설정하거나 환경 변수 (environment variables)를 사용하세요.

[provider]
# openai_api_key = "sk-..."
# anthropic_api_key = "sk-ant-..."
...

OPENAI_API_KEY, ANTHROPIC_API_KEY, GOOGLE_API_KEY, 그리고 OLLAMA_BASE_URL과 같은 셸 환경 변수 (Shell environment variables)가 설정 파일보다 우선순위를 가집니다. 프라이빗 저장소 (private repositories)의 경우, 환경에 GITHUB_TOKEN을 설정하세요.

# 로컬 저장소 분석
python main.py full --local ./my-project
# 다이어그램 깊이 증가
...

• 로컬 분석, 자동화 및 CI 워크플로 (workflows)를 위한 CLI.

• 에디터 내 시각적 아키텍처 (visual architecture)를 위한 VS Code 확장 프로그램 (extension).

• CI에서 다이어그램을 최신 상태로 유지하기 위한 GitHub Action.

• 지원 언어: Python, TypeScript, JavaScript, Java, Go, PHP, Rust.

• LLM 제공자 (providers): OpenAI, Anthropic, Google, Vercel AI Gateway, AWS Bedrock, Ollama, OpenRouter 등.

• 800개 이상의 오픈 소스 저장소 (open-source repositories) 시각화 완료.

• GeneratedOnBoardings에서 생성된 예시들을 찾아보세요.

• codeboarding.org/diagrams에서 호스팅된 익스플로러 (explorer)를 사용해 보세요.

CodeBoarding을 개선하고 싶다면, 이슈 (issue)를 오픈하거나 풀 리퀘스트 (pull request)를 보내주세요. 분석 품질, 출력 생성기 (output generators), 통합 (integrations), 그리고 개발자 경험 (developer experience)에 대한 개선을 환영합니다.

CodeBoarding은 코드 이해를 위한 개방형 표준 (open standard)을 구축하고 있습니다. 즉, 인간과 에이전트 (agents)가 모두 사용할 수 있는 코드베이스의 시각적이고 정확하며 수준 높은 표현을 만드는 것입니다.