pr-pilot-cli 1.8.0

CLI for PR Pilot, a text-to-task automation platform for Github.

Install | Documentation | Blog | Website

PR Pilot Command-Line Interface

PR Pilot gives you a natural language interface for your Github projects. Given a prompt, it uses LLMs (Large Language Models) to autonomously fulfill tasks by interacting with your code base and Github issues.

Using prompt templates, you can create powerful, reusable commands that can be executed by PR Pilot.

🛠️ Usage

Open a terminal and ls into a repository you have installed PR Pilot.

In your repository, use the pilot command:

pilot "Tell me about this project!"

📝 Ask PR Pilot to edit a local file for you:

pilot --edit cli/cli.py "Make sure all functions and classes have docstrings."

⚡ Generate code quickly and save it as a file:

pilot -o test_utils.py --code "Write some unit tests for the utils.py file."

🔍 Capture part of your screen and add it to a prompt:

pilot -o component.html --code --snap "Write a Bootstrap5 component that looks like this."

📊 Get an organized view of your Github issues:

pilot "Find all open Github issues labeled as 'bug', categorize and prioritize them"

📝 Generate parts of your documentation with a template:

pilot --direct -f prompts/README.md.jinja2 -o README.md

To learn more about templates, check out the prompts directory.

📝 Execute a step-by-step plan:

Break down more complex tasks into smaller steps with a plan:

# document_cli.yaml

name: Document the CLI
prompt: |
  The CLI is great, but we need a comprehensive user documentation.
  The documentation should be stored as Markdown files in the repository.

steps:
  - name: Identify documentation needs
    output_file: doc_instructions.md
    prompt: |
      1. Read `cli/cli.py`
      2. Identify the key features of the CLI and how it works
      3. List the documentation files that need to be created and outline their content
      4. Create step-by-step instructions for creating the documentation

  - name: Document the CLI
    template: doc_instructions.md

Run it with pilot --plan document_cli.yaml.

⚙️ Options and Parameters

You can customize your interact with PR Pilot using parameters and options:

Usage: pilot [OPTIONS] [PROMPT]...

  Create a new task for PR Pilot - https://docs.pr-pilot.ai

Options:
  --wait / --no-wait        Wait for PR Pilot to finish the task.
  --repo TEXT               Github repository in the format owner/repo.
  --snap                    Select a portion of your screen to add as an image
                            to the task.
  -p, --plan PATH           Path to YAML file containing step-by-step plan for
                            PR Pilot.
  -e, --edit PATH           Let PR Pilot edit a file for you.
  --spinner / --no-spinner  Display a loading indicator.
  --quiet                   Disable all output on the terminal.
  --cheap                   Use the cheapest GPT model (gpt-3.5-turbo)
  --code                    Optimize prompt and settings for generating code
  -f, --file PATH           Generate prompt from a template file.
  --direct                  Do not feed the rendered template as a prompt into
                            PR Pilot, but render it directly as output.
  -o, --output PATH         Output file for the result.
  -m, --model TEXT          GPT model to use.
  -b, --branch TEXT         Run the task on a specific branch.
  --sync                    Run task on your current branch and pull PR
                            Pilot's changes when done.
  --debug                   Display debug information.
  --help                    Show this message and exit.

⚙️ Configuration

The configuration file is located at ~/.pr-pilot.yaml.

# Your API Key from https://app.pr-pilot.ai/dashboard/api-keys/
api_key: YOUR_API_KEY

# Default Github repository if not running CLI in a repository directory
default_repo: owner/repo

🤝 Contributing

Contributors are welcome to improve the CLI by submitting pull requests or reporting issues. For more details, check the project's GitHub repository.

📜 License

The PR Pilot CLI is open-source software licensed under the GPL-3 license.