Git 統合の概要 - Archyl Docs

Git リポジトリを接続して AI 搭載のアーキテクチャディスカバリーを有効にしましょう

Git 統合の概要

Git リポジトリを Archyl に接続することで、AI 搭載のアーキテクチャディスカバリーが可能になり、ドキュメントを実際のコードと同期させることができます。

サポートされているプロバイダー

Archyl は主要な Git ホスティングプラットフォームをすべてサポートしています:

クラウドプロバイダー

プロバイダー OAuth 機能
GitHub あり フルサポート
GitLab あり フルサポート
Bitbucket あり フルサポート

セルフホスト

プロバイダー 認証方法 機能
GitHub Enterprise トークン フルサポート
GitLab セルフマネージド トークン フルサポート
Gitea トークン フルサポート
Azure DevOps トークン フルサポート

リポジトリの接続

ステップ 1:プロジェクト設定に移動

  1. プロジェクトを開きます
  2. 「設定」をクリックします
  3. 「リポジトリ」タブに移動します

ステップ 2:プロバイダーの選択

  1. 「リポジトリを接続」をクリックします
  2. Git プロバイダーを選択します
  3. Archyl を認証します(OAuth プロバイダーの場合)

ステップ 3:リポジトリの選択

  1. 利用可能なリポジトリを参照します
  2. 接続するリポジトリを選択します
  3. デフォルトブランチを選択します
  4. 「接続」をクリックします

認証

OAuth(推奨)

GitHub、GitLab、Bitbucket クラウドの場合:

  1. 「[プロバイダー] で接続」をクリックします
  2. ポップアップで Archyl を認証します
  3. アクセスを許可するリポジトリを選択します

OAuth トークンは安全に保存され、自動的に更新されます。

パーソナルアクセストークン

セルフホストまたはエンタープライズプロバイダーの場合:

  1. Git プロバイダーでトークンを生成します
  2. 必要なスコープ:repo(読み取りアクセス)
  3. Archyl にトークンを入力します

リポジトリアクセス

Archyl が読み取る内容

AI ディスカバリー中、Archyl は以下を読み取ります:

  • ファイル構造と名前
  • ソースコードの内容
  • 設定ファイル(package.json、go.mod など)
  • README ファイル

Archyl が決してアクセスしない内容

  • 環境ファイル(.env)
  • 資格情報やシークレット
  • Git 履歴
  • 他のブランチ(明示的に選択しない限り)

複数リポジトリ

複数のリポジトリを単一のプロジェクトに接続:

モノレポ

モノレポの場合、一度接続してパスを指定します:

/services/api
/services/web
/packages/shared

マルチレポ

個別のリポジトリの場合:

  1. 各リポジトリを接続します
  2. システムまたはコンテナにマッピングします
  3. ディスカバリーはすべてのリポジトリで実行されます

Webhook(近日公開)

プッシュ時の自動同期:

  • コード変更時にディスカバリーをトリガー
  • アーキテクチャを自動更新
  • ドキュメントを最新に保つ

トラブルシューティング

認証失敗

  • トークンに必要な権限があるか確認してください
  • OAuth アプリが認証済みであることを確認してください
  • 再接続を試みてください

リポジトリが見つからない

  • リポジトリにアクセス権があるか確認してください
  • リポジトリの URL を確認してください
  • ブランチが存在することを確認してください

ディスカバリーエラー

  • 除外パスを確認してください
  • 同時実行設定を減らしてください
  • AI プロバイダーの制限を確認してください