Skip to main content
Get Pullfrog up and running in your repository in just a few minutes.
1

Sign into Pullfrog console with GitHub

Navigate to the Pullfrog console and sign in with your GitHub account. This will authenticate you and allow Pullfrog to access your repositories.Sign in to Pullfrog console with GitHub
2

Install the Pullfrog app

Install the Pullfrog GitHub App on a GitHub account. During installation, you can choose to limit access to specific repositories or grant access to all repositories.You can install the Pullfrog GitHub App on your personal account:Install Pullfrog GitHub App on personal accountOr on an organization you control:Install Pullfrog GitHub App on organizationAfter installation, you’ll be redirected to the Pullfrog dashboard.
3

Select a repository

Select a repository you’d like to configure. While GitHub Apps are installed at the account level, all Pullfrog configuration is at the repo level—each repository has its own settings for triggers, modes, and agents.Select a repository to configure
4

Add the pullfrog.yml workflow

You’ll be prompted to create the .github/workflows/pullfrog.yml file in your repository. Pullfrog uses this workflow to programmatically trigger agent runs on your repo. You can add it with one click from the dashboard.Add pullfrog.yml workflow file with one click
If you prefer to add the workflow manually, create .github/workflows/pullfrog.yml with the following content:
name: Pullfrog
on:
  workflow_dispatch:
    inputs:
      prompt:
        type: string
        description: 'Agent prompt'
  workflow_call:
    inputs:
      prompt:
        description: 'Agent prompt'
        type: string

permissions:
  id-token: write
  contents: read

jobs:
  pullfrog:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 1

      - name: Run agent
        uses: pullfrog/action@v0
        with:
          prompt: ${{ github.event.inputs.prompt }}

          # feel free to comment out any you won't use
          anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
          openai_api_key: ${{ secrets.OPENAI_API_KEY }}
          google_api_key: ${{ secrets.GOOGLE_API_KEY }}
          gemini_api_key: ${{ secrets.GEMINI_API_KEY }}
          cursor_api_key: ${{ secrets.CURSOR_API_KEY }}
5

Add API keys

Navigate to your repository settings on GitHub and add the API keys for your chosen agent(s) as secrets:
  1. Navigate to github.com/your_org/your_repo/settings/secrets/actions
  2. Click New repository secret
  3. Add secrets for your chosen agent:
    • ANTHROPIC_API_KEY (for Claude)
    • OPENAI_API_KEY (for Codex)
    • GOOGLE_API_KEY or GEMINI_API_KEY (for Gemini)
    • CURSOR_API_KEY (for Cursor)
You only need to add secrets for the agents you plan to use. Comment out the unused API key inputs in your workflow file.
6

Test your installation

Once the workflow is installed and your API keys are configured, you can test Pullfrog using the prompt box in the dashboard:
  1. Navigate to your repository in the Pullfrog dashboard
  2. Enter a prompt in the text box (e.g., “Tell me a joke”)
  3. Click the Send button, or press Cmd+Enter (Mac) or Ctrl+Enter (Windows/Linux) Test Pullfrog installation
This will dispatch a new GitHub Actions run and automatically open the run logs in a new tab. Monitor the logs to ensure the agent works as expected.

Next steps

  • Configure triggers to automate agent runs
  • Learn about modes to customize agent behavior
  • See manual setup for advanced configurations