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

To install the CLI, run the following command:

pip install 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.3.tar.gz (15.4 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pr_pilot_cli-1.0.3.tar.gz
  • Upload date:
  • Size: 15.4 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.3.tar.gz
Algorithm Hash digest
SHA256 1e5d99858d2577c4c7db3ec23c55b2f1772ff9ca6c0c130993f518b032856a53
MD5 9cbfe341d66e440c5bad8c0f1ef33738
BLAKE2b-256 5000d78b02e057b01306df6c43f4b8122957f9f4e3b6f7506e5515938aa317e8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pr_pilot_cli-1.0.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7910740199b18047e1a750c904d543428347347e0af91c8c977afef69694e5f1
MD5 87c8cdd3bfbfa69bb4957f9b33587e01
BLAKE2b-256 9ef1a3afda644de1bbe1b1758422f6361470a04f702349109994848eadf3895e

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