Automatic Refresh

The /install-wiki command creates a CI workflow that automatically regenerates a Wiki every time code is pushed to the default branch. It detects your CI framework (GitHub Actions or GitLab CI) and generates the appropriate configuration. This keeps your documentation in sync with your codebase without manual intervention.

Quick start

1. 1
   Open a Droid session in your repo

   Bash

   cd /path/to/your/project
   droid

2. 2
   Run the install command

   > /install-wiki
   

   Droid creates a workflow file and opens a pull request for you to review.

3. 3
   Add the Factory API key

   Add FACTORY_API_KEY as a secret in your CI settings:

   • GitHub: Repository Settings > Secrets and variables > Actions (or at the organization level under Organization Settings > Secrets and variables > Actions)
   • GitLab: Repository Settings > CI/CD > Variables (or at the group level under Group Settings > CI/CD > Variables)

   Generate a key in the Factory API keys settings.

4. 4
   Merge the PR

   Once the secret is configured, merge the workflow PR. The Wiki will now refresh automatically on every push to the default branch.

Generated workflows

Droid detects your CI framework and creates the appropriate configuration.

GitHub Actions

Creates .github/workflows/droid-wiki-refresh.yml (replace main with your default branch if different):

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

Appends a job to your existing .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

Both workflows:

• Trigger on push to the default branch
• Install the Droid CLI using the official installer
• Run /wiki in headless mode with high autonomy, generating the Wiki and storing it in the Factory App with Cloud Sync

Prerequisites

• A GitHub or GitLab hosted repository
• A Factory API key (generate one in the Factory API keys settings)
• Permission to add secrets and merge PRs in the target repository

Refreshing from the Factory App

You can also set up recurring refreshes from the Factory App:

1. 1
   Go to app.factory.ai/wiki
2. 2
   Click Refresh on the Wiki page
3. 3
   Select Recurring (on push)
4. 4
   Choose a Local or Cloud method:

   • Local: Copies the /install-wiki command for you to run in a local clone
   • Cloud: Selects a cloud template or Droid Computer to run the setup remotely

For batch operations across multiple repositories, the Factory App lets you select several repos and run the setup on a Droid Computer in a single operation.

See Wiki Browser for more on the Factory App interface.

Troubleshooting