Pullfrog

https://docs.pullfrog.com/
Admin
Pullfrog is a GitHub integration that enables coding agents to write code, make plans, and review...
Tokens:12,389
Snippets:180
Trust Score:5.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example of using a flag in a prompt

Source: https://docs.pullfrog.com/flags

This example shows how a flag like `--refactor` expands into its defined replacement text when used in a prompt.

```text
@pullfrog clean up the auth module --refactor
```

--------------------------------

### Setup Codex Authentication

Source: https://docs.pullfrog.com/codex-auth

Run this command within your repository to initiate the Codex authentication process. It securely stores your ChatGPT subscription credentials for use with Pullfrog.

```bash
npx pullfrog auth codex
```

--------------------------------

### Expanded prompt after flag resolution

Source: https://docs.pullfrog.com/flags

This demonstrates the result of the previous example, where the `--refactor` flag has been replaced by its full text.

```text
@pullfrog clean up the auth module Follow the boy scout rule: leave code cleaner than you found it. Extract duplicated logic into shared utilities. Prefer composition over inheritance.
```

--------------------------------

### Agent-Authored Changelog in Release Flow

Source: https://docs.pullfrog.com/headless-action

This example demonstrates how to use the Pullfrog action to draft a changelog from commits and integrate it into a GitHub release workflow. The `output_schema` ensures the agent's output is a typed contract for downstream steps.

```yaml
# .github/workflows/release.yml
name: Release

on:
  workflow_dispatch:
    inputs:
      version:
        description: Semver to release
        required: true

permissions:
  contents: write
  id-token: write

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0

      - name: Draft changelog
        id: changelog
        uses: pullfrog/pullfrog@v0
        with:
          prompt: |
            Read the commits between the latest tag and HEAD (use `git log`).
            Write a concise, user-facing changelog grouped by Added / Changed /
            Fixed. Skip internal refactors and chores. Output JSON only —
            no prose outside the schema.
          output_schema: |
            {
              "type": "object",
              "required": ["title", "markdown"],
              "properties": {
                "title": { "type": "string" },
                "markdown": { "type": "string" }
              }
            }

      # downstream steps consume the agent's output as a contract
      - name: Build & publish
        run: pnpm release ${{ inputs.version }}

      - name: Create GitHub release
        uses: softprops/action-gh-release@v2
        with:
          tag_name: v${{ inputs.version }}
          name: ${{ fromJSON(steps.changelog.outputs.result).title }}
          body: ${{ fromJSON(steps.changelog.outputs.result).markdown }}

```

--------------------------------

### Code reviews

Source: https://docs.pullfrog.com/tools

Tools for managing code reviews, including listing reviews, getting comments, submitting reviews, and resolving threads.

```APIDOC
## Tool: list_pull_request_reviews

### Description
Lists all reviews on a pull request.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: get_review_comments

### Description
Gets full review thread context.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: create_pull_request_review

### Description
Submits a review with optional inline comments and suggestions.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: reply_to_review_comment

### Description
Replies to a review comment thread.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: resolve_review_thread

### Description
Marks a review thread as resolved.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

--------------------------------

### Configure GitHub Actions Secret for BYOK

Source: https://docs.pullfrog.com/keys

Example of how to map a GitHub Actions secret to the Pullfrog agent environment variable within a workflow file. This allows Pullfrog to access your provider API key stored in GitHub secrets.

```yaml
jobs:
  pullfrog:
    runs-on: ubuntu-latest
    steps:
      - name: Run agent
        uses: pullfrog/pullfrog@v0
        with:
          prompt: ${{ inputs.prompt }}
          env:
            ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
```

--------------------------------

### Utilities

Source: https://docs.pullfrog.com/tools

General utility tools for file uploads and setting workflow outputs.

```APIDOC
## Tool: upload_file

### Description
Uploads a local file and returns a permanent public URL.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: set_output

### Description
Sets the GitHub Action `result` output for downstream workflow steps.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

--------------------------------

### Git

Source: https://docs.pullfrog.com/tools

Tools for executing local and remote Git commands.

```APIDOC
## Tool: git

### Description
Runs local git commands (`status`, `diff`, `add`, `commit`, etc.).

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: git_fetch

### Description
Fetches from remote.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: push_branch

### Description
Pushes a branch (with permission and destination checks).

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: delete_branch

### Description
Deletes a remote branch.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: push_tags

### Description
Pushes tags to remote.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: get_commit_info

### Description
Gets commit metadata and a formatted diff.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

--------------------------------

### Configure Vertex AI Environment Variables in Pullfrog Workflow

Source: https://docs.pullfrog.com/vertex

This snippet shows how to set up the necessary environment variables in a pullfrog.yml workflow file to use Google Vertex AI. It includes placeholders for your project, location, and model ID, and demonstrates how to securely provide the service account JSON.

```yaml
- name: Run agent
  uses: pullfrog/pullfrog@v0
  with:
    prompt: ${{ inputs.prompt }}
  env:
    # ... your other provider keys ...
    VERTEX_SERVICE_ACCOUNT_JSON: ${{ secrets.VERTEX_SERVICE_ACCOUNT_JSON }}
    GOOGLE_CLOUD_PROJECT: my-project
    VERTEX_LOCATION: global
    VERTEX_MODEL_ID: <vertex-model-id>
```

--------------------------------

### CI

Source: https://docs.pullfrog.com/tools

Tool for retrieving CI check suite logs.

```APIDOC
## Tool: get_check_suite_logs

### Description
Gets failed CI logs with extracted errors and relevant excerpts.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

--------------------------------

### Issues and labels

Source: https://docs.pullfrog.com/tools

Tools for managing issues and labels, including creation, retrieval, commenting, and applying labels.

```APIDOC
## Tool: create_issue

### Description
Creates a new issue with optional labels and assignees.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: get_issue

### Description
Gets issue metadata and current state.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: get_issue_comments

### Description
Gets all comments on an issue.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: get_issue_events

### Description
Gets issue timeline events like cross-references and linked commits.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: create_issue_comment

### Description
Adds a comment to an issue.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: edit_issue_comment

### Description
Edits an existing issue comment.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: add_labels

### Description
Adds labels to an issue or pull request.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

--------------------------------

### Configure Bedrock Credentials and Model in pullfrog.yml

Source: https://docs.pullfrog.com/bedrock

This snippet shows how to set environment variables in your pullfrog.yml file to use Amazon Bedrock. It includes storing the Bedrock API key as a secret and specifying the AWS region and model ID.

```yaml
- name: Run agent
  uses: pullfrog/pullfrog@v0
  with:
    prompt: ${{ inputs.prompt }}
  env:
    # ... your other provider keys ...
    AWS_BEARER_TOKEN_BEDROCK: ${{ secrets.AWS_BEARER_TOKEN_BEDROCK }}
    AWS_REGION: us-east-1
    BEDROCK_MODEL_ID: <bedrock-model-id>
```

--------------------------------

### Pull requests

Source: https://docs.pullfrog.com/tools

Tools for managing pull requests, including checking out branches, creating, and retrieving PR information.

```APIDOC
## Tool: checkout_pr

### Description
Checks out a PR branch locally and returns a formatted diff.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: create_pull_request

### Description
Creates a pull request from the current branch.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

```APIDOC
## Tool: get_pull_request

### Description
Gets PR metadata: title, state, branches, labels, and linked issues.

### Method
Not specified (Tool invocation)

### Endpoint
Not specified (Tool invocation)
```

--------------------------------

### Add pullfrog.yml Workflow

Source: https://docs.pullfrog.com/getting-started

This YAML workflow file is used by Pullfrog to programmatically trigger agent runs on your repository. It defines the workflow name, trigger conditions, permissions, and steps, including checking out code and running the Pullfrog agent.

```yaml
name: Pullfrog
run-name: ${{ inputs.name || github.workflow }}
on:
  workflow_dispatch:
    inputs:
      prompt:
        type: string
        description: Agent prompt
      name:
        type: string
        description: Run name

permissions: 
  contents: read

jobs:
  pullfrog:
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: read
    steps:
      - name: Checkout code
        uses: actions/checkout@v6
        with:
          fetch-depth: 1
      - name: Run agent
        uses: pullfrog/pullfrog@v0
        with:
          prompt: ${{ inputs.prompt }}
```

--------------------------------

### Specify Model in Pullfrog Workflow

Source: https://docs.pullfrog.com/models

This snippet shows how to set a specific model alias for a Pullfrog job within a GitHub Actions workflow. Ensure the corresponding API key is set as a secret.

```yaml
jobs:
  pullfrog:
    runs-on: ubuntu-latest
    steps:
      - name: Run agent
        uses: pullfrog/pullfrog@v0
        with:
          prompt: ${{ inputs.prompt }}
          model: openrouter/anthropic/claude-sonnet-4.6
        env:
          OPENROUTER_API_KEY: ${{ secrets.OPENROUTER_API_KEY }}
```
Tokens:
Raw