> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pullfrog.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Getting started
> Install the Pullfrog GitHub App, choose how to pay for models, add the workflow, and send a first prompt.
A repository needs two things to run Pullfrog: the Pullfrog GitHub App and a `.github/workflows/pullfrog.yml` workflow. The console sets up both.
Sign in to the [Pullfrog console](https://pullfrog.com/console) with your GitHub account.
Install the Pullfrog GitHub App on your personal account or on an organization. You can give it access to every repository or only the ones you pick.
The console asks for a billing mode. On an organization, an org owner makes this choice.
* **Bring your own key**: a provider API key or an existing subscription, billed by your provider. The console then asks for the provider, its credentials, and a model.
* **Pullfrog Router**: every model through Pullfrog's gateway, paid from a balance at provider cost with no markup. By default, Pullfrog picks the model for each run.
You can switch later under **Providers** in the console's **Billing** section. [Model access](/model-access) compares the options, including [free models](/model-access#free-models).
Pick the repositories to set up. The console commits `.github/workflows/pullfrog.yml` to each repository's default branch, or opens a PR when branch protection blocks the commit.
To set up a repository later, open it in the console and click **Add workflow directly** or **Add workflow via PR**.
Open the repository in the console and type a prompt, such as "Summarize what this repository does." Press the send button, or `Cmd+Enter` (`Ctrl+Enter` on Windows and Linux). Pullfrog dispatches a GitHub Actions run and opens its logs in a new tab.
## Manual workflow setup
To add the workflow yourself, create `.github/workflows/pullfrog.yml` (or `pullfrog.yaml`) on the default branch, then click **Verify manual installation** on the repository's console page.
```yaml theme={null}
# PULLFROG ACTION — DO NOT EDIT EXCEPT WHERE INDICATED
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 }}
```
The console's version adds an `env:` block that maps provider keys from GitHub Actions secrets. Add one only if you keep keys there; Pullfrog Router and keys stored in Pullfrog need no workflow changes. See [GitHub Actions secrets](/keys#github-actions-secrets).
## Next steps
* Set up [PR reviews](/pr-reviews), [issue enrichment](/issue-enrichment), and other automations
* Tune [build](/coding-tasks#build-instructions) and [review](/pr-reviews#review-instructions) instructions for your repo
* Use the action in your own workflows with [CI integration](/headless-action)
## Uninstall Pullfrog
Uninstalling the GitHub App stops every run on that account.
1. Open the installed GitHub Apps for your [personal account](https://github.com/settings/installations), or `https://github.com/organizations//settings/installations` for an organization.
2. Click **Configure** next to Pullfrog.
3. Click **Uninstall** at the bottom of the page.
The workflow does nothing without the app, so deleting `pullfrog.yml` is optional. To delete your Pullfrog account and its data, email [support@pullfrog.com](mailto:support@pullfrog.com).
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.