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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file pr_pilot_cli-1.0.4.tar.gz.

File metadata

  • Download URL: pr_pilot_cli-1.0.4.tar.gz
  • Upload date:
  • Size: 15.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for pr_pilot_cli-1.0.4.tar.gz
Algorithm Hash digest
SHA256 33a5b1891c68759e87df7d632e7eca2514f2098607c0236bccbe2ad6f09898b0
MD5 371a6db6c2d450b44636319507da1fc3
BLAKE2b-256 c022fe3745c4e5de2591b12851e518fedc1b7eb397bdda2bf6ce1cbf2b11b539

See more details on using hashes here.

File details

Details for the file pr_pilot_cli-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: pr_pilot_cli-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 15.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for pr_pilot_cli-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 deb5ac68d33e7ee0020694679a07aae324c1d4089000910c9518ed8dcd027043
MD5 1b0c4b54906c0f3cb0ec502f668c8790
BLAKE2b-256 bd3045f39771102a1321f94d94b5802ce260028cc020087b6ac8f3c1cb20d534

See more details on using hashes here.

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