Skip to main content

A command line application to help wrap the OpenAI ChatGPT api.

Project description

Actions Status Actions Status Quality Gate Status CodeQL Codacy Badge []

Prompt 🥝 - A ChatGPT CLI

prompt is designed to provide users a command-line interface for the ChatGPT API, which uses OpenAI's GPT language model to generate text based on user input.

The application helps you start a session with ChatGPT so that the context is preserved and longer conversions with contexts are considered. The user's prompts and the responses are sent back to ChatGPT everytime.

The ChatGPT api usage depends on the number of tokens used and it is important that you use the tokens wisely. After a prompt has been answered the application will resend the last prompt and answer in the next prompt, this makes sure you can have a continued conversion with ChatGPT much like using ChatGPT in a single chat session. This makes the token count larger and larger as you continue to chat. If you are not concerned with context use the --clear flag which will save your token usage. Use the model option to add

I hope you find it useful.

Configuration

The application requires you to have an api token to query the OpenAI's ChatGPT api. You can read about and get it here https://platform.openai.com/account/api-keys .

Installation

Install the prompt python package directly from pypi.

  pip install promptcli

I would recommend using pipx instead of pip to install cli applications on you machine.

Usage

Usage: prompt [OPTIONS] COMMAND [ARGS]...

  🥝 A command line application to interact with OpenAI's ChatGPT.

Options:
  --version     Show the version and exit.
  --clear    🌊 Clear the context each round of chat
  --model    🔄 The OpenAI model type.
  --help        Show this message and exit.

Commands:
  update  🔐 Update the OpenAI API key.

Please feel to create issues or request for features. More options and commands will be added to the application in the near future.

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

promptcli-2.1.0.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

promptcli-2.1.0-py2.py3-none-any.whl (4.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file promptcli-2.1.0.tar.gz.

File metadata

  • Download URL: promptcli-2.1.0.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.18

File hashes

Hashes for promptcli-2.1.0.tar.gz
Algorithm Hash digest
SHA256 5c19fbc641ce197c34ff5490dd214f891a8d3305dcef4d99a2d8156d67d36ce4
MD5 571967c1ecd32cda9e864a2c2469f2fd
BLAKE2b-256 d8db55dd6f3c5e7e25460b1edeaf3b916da5a9d58e4d9b1a458263a2004db0e0

See more details on using hashes here.

File details

Details for the file promptcli-2.1.0-py2.py3-none-any.whl.

File metadata

  • Download URL: promptcli-2.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.18

File hashes

Hashes for promptcli-2.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7fb7a5983c189247afad357924ff0e823c9f089439efa4e82d8416b72666caf3
MD5 ccf838b56b1a3face12dc66e0c26eddd
BLAKE2b-256 801c435e618e08b33da982b674f7fbeca6bf68d48a55fd08dcb8455b30949557

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