pr-pilot-cli 1.1.0

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

Install | Documentation | Blog | Website

PR Pilot CLI

The PR Pilot CLI is a command-line interface tool designed to interact with the PR Pilot API. It allows users to quickly hand over work to PR Pilot from the command line.

Features

• Configuration Management: Automatically manages API key configuration by prompting the user to input their API key if not already configured.
• Task Creation: Users can create tasks by specifying a repository and a prompt. The CLI handles task creation and optionally waits for the result.
• Result Retrieval: If the --wait option is used, the CLI waits for the task to complete and displays the result directly in the terminal.
• Dashboard Link: For tasks that are not awaited, the CLI provides a link to the task's dashboard for further monitoring.

Installation

Make sure you have PR Pilot installed in your repository

To install the CLI, run the following command:

pip install --upgrade pr-pilot-cli

By default, the CLI will prompt you to input your API key if it is not already configured.

Usage

After installation, open a terminal and ls into a repository you have installed PR Pilot in and talk to PR Pilot:

pilot Translate the README file into German.

Options and Parameters

You can change the default settings with parameters and options:

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

Options:
  --wait / --no-wait  Wait for the result.
  --repo TEXT         Github repository in the format owner/repo.
  --chatty            Print more information.
  --help              Show this message and exit.

Configuration

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

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.