Skip to main content

Documentation Index

Fetch the complete documentation index at: https://factory-docs-auto-sync-jp-docs.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

/install-wiki コマンドは、デフォルトブランチにコードが push されるたびに wiki を自動的に再生成する CI ワークフローを作成します。CI フレームワーク（GitHub Actions または GitLab CI）を検出し、適切な設定を生成します。これにより、手動の介入なしでドキュメントをコードベースと同期した状態に保てます。

​
クイックスタート

1

リポジトリで Droid セッションを開く

cd /path/to/your/project
droid
2

インストールコマンドを実行する

> /install-wiki
Droid はワークフローファイルを作成し、レビュー用の PR を開きます。
3

Factory API キーを追加する

CI 設定で FACTORY_API_KEY をシークレットとして追加します：
  • GitHub: リポジトリの Settings > Secrets and variables > Actions（または組織レベルの Organization Settings > Secrets and variables > Actions）
  • GitLab: リポジトリの Settings > CI/CD > Variables（またはグループレベルの Group Settings > CI/CD > Variables）
キーは app.factory.ai/settings/api-keys で生成できます。
4

PR をマージする

シークレットを設定したら、ワークフローの PR をマージします。これで、デフォルトブランチへの push ごとに wiki が自動更新されます。

​
生成されるワークフロー

Droid は CI フレームワークを検出し、適切な設定を作成します。

​
GitHub Actions

.github/workflows/droid-wiki-refresh.yml を作成します（異なる場合は main をデフォルトブランチ名に置き換えてください）： 
name: Droid Wiki Refresh

on:
  push:
    branches: [main] # change to your default branch if not main

jobs:
  wiki-refresh:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install Factory Droid
        run: curl -fsSL https://app.factory.ai/cli | sh

      - name: Generate wiki
        run: droid exec --auto high "/wiki"
        env:
          FACTORY_API_KEY: ${{ secrets.FACTORY_API_KEY }}

​
GitLab CI

既存の .gitlab-ci.yml にジョブを追記します： 
droid-wiki-refresh:
  stage: deploy
  before_script:
    - curl -fsSL https://app.factory.ai/cli | sh
  script:
    - droid exec --auto high "/wiki"
  rules:
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
  variables:
    FACTORY_API_KEY: $FACTORY_API_KEY
どちらのワークフローも以下を行います：
  • デフォルトブランチへの push をトリガー にする
  • 公式インストーラーで Droid CLI をインストール する
  • 高い自律性の headless モードで /wiki を実行 し、wiki を生成してアップロードする
インストール後にワークフローをカスタマイズすることもできます。たとえば、トリガーブランチを変更したり、ソースファイルが変わった時だけ再生成するようにパスフィルターを追加したり、タイムアウトを調整したりできます。

​
前提条件

  • GitHub または GitLab でホストされているリポジトリ
  • Factory API キー（app.factory.ai/settings/api-keys で生成）
  • 対象リポジトリでシークレットを追加し、PR をマージする権限

​
Web から更新する

Factory Web アプリから定期更新を設定することもできます：
  1. app.factory.ai/wiki に移動する
  2. wiki ページで Refresh をクリックする
  3. Recurring (on push) を選択する
  4. Local または Cloud の方法を選ぶ：
    • Local — ローカル clone で実行するための /install-wiki コマンドをコピーします
    • Cloud — セットアップをリモート実行する cloud template または Droid Computer を選択します
複数のリポジトリをまとめて操作する場合、Web UI では複数の repo を選択し、1 回の操作で Droid Computer 上でセットアップを実行できます。 Web インターフェースの詳細は Webビューア を参照してください。

​
トラブルシューティング

リポジトリの Settings > Secrets and variables > Actions に FACTORY_API_KEY シークレットが正しく設定されていることを確認してください。必要に応じて、 app.factory.ai/settings/api-keys で新しいキーを生成してください。
.github/workflows/droid-wiki-refresh.yml にワークフローファイルが存在し、 ブランチトリガーがデフォルトブランチと一致していることを確認してください。ワークフロー実行ログは リポジトリの Actions タブで確認できます。
Factory が push する前に GitHub wiki タブを初期化しておく必要があります。 https://github.com/{owner}/{repo}/wiki で最初のページを手動で作成してください。あわせて、 組織で Wiki Cloud Sync が無効化されていないことも確認してください。

​
関連情報