> ## Documentation Index
> Fetch the complete documentation index at: https://factory-docs-cli-sandbox-mcp-whole-process.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# AutoWiki Refresh

> /install-wiki を使って、デフォルトブランチへの push ごとにAutoWikiを再生成する CI アクションを設定します。

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

## クイックスタート

<Steps>
  <Step title="リポジトリで Droid セッションを開く">
    ```bash theme={null}
    cd /path/to/your/project
    droid
    ```
  </Step>

  <Step title="インストールコマンドを実行する">
    ```
    > /install-wiki
    ```

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

  <Step title="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](https://app.factory.ai/settings/api-keys) で生成できます。
  </Step>

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

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

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

### GitHub Actions

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

```yaml theme={null}
name: Droid AutoWiki 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` にジョブを追記します：

```yaml theme={null}
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を生成してFactory AppにCloud Syncで保存する

<Tip>
  インストール後にワークフローをカスタマイズすることもできます。たとえば、トリガーブランチを変更したり、ソースファイルが変わった時だけ再生成するようにパスフィルターを追加したり、タイムアウトを調整したりできます。
</Tip>

## 前提条件

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

## Web から更新する

Factory Appから定期更新を設定することもできます：

1. [app.factory.ai/wiki](https://app.factory.ai/wiki) に移動する
2. AutoWikiページで **Refresh** をクリックする
3. **Recurring (on push)** を選択する
4. **Local** または **Cloud** の方法を選ぶ：
   * **Local** -- ローカル clone で実行するための `/install-wiki` コマンドをコピーします
   * **Cloud** -- セットアップをリモート実行する cloud template または Droid Computer を選択します

複数のリポジトリをまとめて操作する場合、Factory App では複数の repo を選択し、1 回の操作で Droid Computer 上でセットアップを実行できます。

Factory Appインターフェースの詳細は [Factory App内のAutoWiki](/jp/cli/features/wiki/web-viewer) を参照してください。

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

<AccordionGroup>
  <Accordion title="認証エラーでワークフローが失敗する">
    リポジトリの **Settings > Secrets and variables > Actions** に
    `FACTORY_API_KEY` シークレットが正しく設定されていることを確認してください。必要に応じて、
    [app.factory.ai/settings/api-keys](https://app.factory.ai/settings/api-keys)
    で新しいキーを生成してください。
  </Accordion>

  <Accordion title="push 後にAutoWikiが更新されない">
    `.github/workflows/droid-wiki-refresh.yml` にワークフローファイルが存在し、
    ブランチトリガーがデフォルトブランチと一致していることを確認してください。ワークフロー実行ログは
    リポジトリの Actions タブで確認できます。
  </Accordion>

  <Accordion title="GitHub wiki が同期されない">
    Factory が push する前に GitHub wiki タブを初期化しておく必要があります。
    `https://github.com/{owner}/{repo}/wiki` で最初のページを手動で作成してください。あわせて、
    組織で [AutoWiki Cloud Sync](/jp/cli/features/wiki/overview#autowiki-cloud-sync) が無効化されていないことも確認してください。
  </Accordion>
</AccordionGroup>

## 関連情報

* [Wikiを生成する](/jp/cli/features/wiki/generate) -- `/wiki` を使った一度きりのAutoWiki生成
* [Wikiを閲覧する](/jp/cli/features/wiki/web-viewer) -- Factory Appから閲覧と検索を行う
* [自動コードレビュー](/jp/guides/droid-exec/code-review) -- コードレビュー自動化向けの類似ワークフロー
* [Droid Exec](/jp/cli/droid-exec/overview) -- 生成されたワークフローで使用される headless モード