HN 日本語サマリー

← 一覧へ戻る
Web開発

Show HN: Onboard-CLI、LLM搭載でASTベースのコードベース可視化ツール

Show HN: Onboard-CLI, a LLM powered and AST-based tool to visualize codebase (github.com)

18 pointsby yr_animesh3 コメント

要約

Onboard-CLIは、LLMと抽象構文木(AST)解析を活用したコマンドラインインターフェース(CLI)ツールおよびWebベースのビジュアライザーです。Tree-sitterを用いてコードを解析し、Go、JavaScript、Python、Javaなど複数の言語に対応した構造トポロジーグラフを生成します。これにより、開発者は複雑なコードベースの依存関係やアーキテクチャを迅速に理解し、アーキテクチャの境界違反を検出できます。

全文翻訳

Onboard-CLI

Untitled.design.1.1.mp4[動画]

コード解析、システムプロファイリング、キャンバスベースのノード可視化のための開発者プラットフォーム。

[画像: Go Version] [画像: React Version] [画像: License: MIT]

Onboard-CLI は、開発者が大規模で複雑なコードベースを迅速に理解し、マッピングするのを支援するために設計された高度なコマンドラインインターフェース(CLI)ツールおよびWebベースのビジュアライザーです。Tree-sitter を介した AST(抽象構文木)解析を活用することで、Onboard-CLI は構造トポロジーグラフを生成し、アーキテクチャ境界を強制し、直感的な React Flow キャンバスを通じてそれらを提示します。

🌟 主な機能

  • AST スライシングエンジン: tree-sitter を使用したディープコード解析により、複数の言語(Go、JS、TS、Python、Java)にわたる正確な構造ノード生成を実現します。
  • インタラクティブビジュアライザー (map): 指定された半径内のコードパス、依存関係、トポロジカルマップを視覚的に探索するために、ローカルの React Flow キャンバス(デフォルトでは http://localhost:3000/app)を自動的に起動します。別のポートで実行するには --port または ONBOARD_PORT を使用してください。
  • アーキテクチャドリフト検出 (drift): architecture.yml ルールに対してコードベースを分析し、不正なファイル間インポートや境界違反を検出して、長期的なコードの健全性を保証します。
  • 包括的なエコシステム: 設定管理、影響分析、コードエクスポート、オーナー追跡、プロジェクトパルスなどの組み込みコマンドを備えています。
  • モダンな技術スタック: Go で記述された非常に高速な CLI と、Vite、React 19、@xyflow/react(React Flow)、Framer Motion、Tailwind CSS を活用したリッチなフロントエンドを組み合わせています。

📊 統計と機能

  • 言語サポート: 5つ以上の組み込みパーサー(Go、TypeScript、JavaScript、Python、Java)。
  • 可視化半径: 設定可能なディープマッピング(デフォルト半径: 1、複雑な依存関係ツリーにもスケールします)。
  • ルール強制: 数千ファイルにわたるアーキテクチャドリフトに対するサブ秒単位の境界正規表現評価。
  • フロントエンドパフォーマンス: Vite & SWC/Oxc リンティングによって強化された、大規模ノードセット向けの最適化されたキャンバスレンダリング。

🚀 インストール

提供されているインストールスクリプトを使用して Onboard-CLI をインストールできます。

macOS / Linux
curl -fsSL https://raw.githubusercontent.com/onboard-cli/install.sh | bash

(または、リポジトリから直接 ./install.sh を実行してください)。

Windows
Invoke-WebRequest -Uri https://raw.githubusercontent.com/onboard-cli/install.ps1 -OutFile install.ps1; .\install.ps1

💻 使用方法

1. プロジェクトの初期化

必要な .onboard ファイルを生成します。

onboard init

CI/CD のために、以下のコマンドを使用して必要な設定ファイルと architecture.yaml ファイルを生成します。

onboard init --template clean-architecture

(利用可能なテンプレート: generic、clean-architecture、modular-monolith、mvc、serverless)

2. コードベースのマッピング(ビジュアライザー)

コンテキストエンジンをトリガーしてシンボルまたはファイルパスをマッピングし、ビジュアライザーサーバーを起動します。

onboard map --target "internal/parser" --radius 2

👉 提供されたリンク(例: http://localhost:3000/app)をクリックして、インタラクティブなキャンバスを表示します。UI で Ctrl+P を押してファジーファインダーを使用してください!右上からダークモードとコンパクトモードを切り替えることができます。

3. バックエンドルートの抽出

さまざまなフレームワーク(Express、Gin、FastAPI、Spring)にわたるバックエンド API ルートを、正確なファイルおよび行ハンドラの位置に自動的にマッピングします。

onboard routes --protocol rest --framework express
4. アーキテクチャドリフトの検出

定義したアーキテクチャルールに対する違反がないかチェックします。

onboard drift --rules architecture.yml
5. CI/CD 統合

onboard drift を GitHub Actions ワークフローに統合して、すべてのプルリクエストでアーキテクチャ境界を強制します。テンプレートは docs/onboard-action.yml で確認できます。

6. 追加コマンド
  • onboard impact: 提案されたコード変更の影響を分析します。
  • onboard owners: コードの所有権とメンテナーを追跡します。
  • onboard export: グラフィカル/AST データをエクスポートします。
  • onboard pulse: コードベースの健全性と最近のアクティビティの概要を素早く取得します。

(注: すべてのコマンドに --no-update-check グローバルフラグを渡すことで、非同期バージョンチェッカーを無効にできます)。

🛠️ 技術スタック

  • CLI エンジン: Go、Cobra、Go-Tree-Sitter、YAML。
  • Web UI: React 19、TypeScript、Vite、@xyflow/react(React Flow)、Tailwind CSS、Framer Motion、Lucide React。
  • コードハイライトと Markdown: Shiki、MDX、Rehype。

🤝 貢献

皆様からの貢献を歓迎します!CLI ロジックについては cmd および internal ディレクトリを、React フロントエンドについては ui ディレクトリをご確認ください。

プルリクエストを送信する前に、貢献ガイドラインとAI 使用ポリシーをお読みください。

  1. リポジトリをフォークする
  2. 機能ブランチを作成する (git checkout -b feature/amazing-feature)
  3. 変更をコミットする (git commit -m 'Add some amazing feature')
  4. ブランチにプッシュする (git push origin feature/amazing-feature)
  5. プルリクエストを開く

📝 ライセンス

MIT ライセンスで配布されています。詳細については LICENSE を参照してください。