Skip to main content

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

Project description

PR Pilot Logo

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

Usage

After installation, create tasks using the following command:

pr-pilot --wait <repo> <prompt>

Replace <repo> and <prompt> with the appropriate repository and task prompt.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pr_pilot_cli-1.0.4.tar.gz (15.5 kB view hashes)

Uploaded Source

Built Distribution

pr_pilot_cli-1.0.4-py3-none-any.whl (15.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page