Skip to main content

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

Project description

PR Pilot CLI

Overview

The PR Pilot CLI is a command-line interface tool designed to interact with the PR Pilot API. It allows users to automate tasks related to pull requests and issue management on GitHub repositories.

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 use the PR Pilot CLI, users need to install it on their system. The installation process typically involves cloning the repository and setting up the necessary dependencies.

Usage

To use the CLI, run the following command:

python cli.py --wait <repo> <prompt>

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

Configuration

The configuration file is located at ~/.pr-pilot.yaml. Users need to ensure that their API key is correctly configured to use the CLI effectively.

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 MIT 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.0.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

pr_pilot_cli-1.0.0-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pr_pilot_cli-1.0.0.tar.gz
  • Upload date:
  • Size: 14.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.0.tar.gz
Algorithm Hash digest
SHA256 a6ec87ba49eb0d736ddaf156b79f2d97461cb8b695cdc465c93f3fc4612ec520
MD5 07eb29a7c7bbf792f0e5cf7185694fd7
BLAKE2b-256 753800ed9e1bccd39d193a456304158bb10f71f2b02a177171ca2088e895bf7d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pr_pilot_cli-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 14.5 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5b04b46ef62d92ce284f1c71ebd95ee08e9b14a758411f4efce5a319e8a345c2
MD5 8079ea1131a4985d802d2f8c57ec283d
BLAKE2b-256 595c499081a2d9b90cd10c7fa19ace454567191002a2737bfebc442cd0b22451

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