[](https://github.com/raiyanyahya/prompt/actions) [](https://github.com/raiyanyahya/prompt/actions) [](https://sonarcloud.io/summary/new_code?id=raiyanyahya_prompt) [](https://github.com/raiyanyahya/prompt/actions?query=workflow%3ACodeQL) [](https://www.codacy.com/gh/raiyanyahya/prompt/dashboard?utm_source=github.com&utm_medium=referral&utm_content=raiyanyahya/prompt&utm_campaign=Badge_Grade) [] [](https://svgshare.com/i/Zhy.svg)[](https://svgshare.com/i/ZjP.svg)
# 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.
```console
pip install promptcli
```
I would recommend using pipx instead of pip to install cli applications on you machine.
## Usage
```console
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/raiyanyahya/prompt",
"name": "promptcli",
"maintainer": "",
"docs_url": null,
"requires_python": ">3.5",
"maintainer_email": "",
"keywords": "cli,developer tools,productivity,openai,chatgpt",
"author": "Raiyan Yahya",
"author_email": "raiyanyahyadeveloper@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a1/34/9b90fb40c068532ce543ce7d00ecf401890078ae9bc9070ced3b2592a71b/promptcli-2.0.0.tar.gz",
"platform": null,
"description": "[](https://github.com/raiyanyahya/prompt/actions) [](https://github.com/raiyanyahya/prompt/actions) [](https://sonarcloud.io/summary/new_code?id=raiyanyahya_prompt) [](https://github.com/raiyanyahya/prompt/actions?query=workflow%3ACodeQL) [](https://www.codacy.com/gh/raiyanyahya/prompt/dashboard?utm_source=github.com&utm_medium=referral&utm_content=raiyanyahya/prompt&utm_campaign=Badge_Grade) [] [](https://svgshare.com/i/Zhy.svg)[](https://svgshare.com/i/ZjP.svg)\n\n# Prompt \ud83e\udd5d - A ChatGPT CLI\n\n\n\n`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.\n\nThe 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.\n\nThe 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 \n\nI hope you find it useful.\n\n\n## Configuration\n\nThe 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 .\n\n## Installation\n\nInstall the prompt python package directly from pypi. \n\n```console\n pip install promptcli\n```\nI would recommend using pipx instead of pip to install cli applications on you machine.\n\n## Usage\n\n```console\nUsage: prompt [OPTIONS] COMMAND [ARGS]...\n\n \ud83e\udd5d A command line application to interact with OpenAI's ChatGPT.\n\nOptions:\n --version Show the version and exit.\n --clear \ud83c\udf0a Clear the context each round of chat\n --model \ud83d\udd04 The OpenAI model type.\n --help Show this message and exit.\n\nCommands:\n update \ud83d\udd10 Update the OpenAI API key.\n```\n\n\nPlease feel to create issues or request for features. More options and commands will be added to the application in the near future.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A command line application to help wrap the OpenAI ChatGPT api.",
"version": "2.0.0",
"split_keywords": [
"cli",
"developer tools",
"productivity",
"openai",
"chatgpt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d62717e2824d3499a2ec212e0f296f9355d0ce33286ab0cbf357d7a142d94470",
"md5": "3bf0dc705512e9814aae67b43f60f24d",
"sha256": "29ea266f839bfb59a9330bca4cac279e62122efff27fba53dcffb0198f139fda"
},
"downloads": -1,
"filename": "promptcli-2.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "3bf0dc705512e9814aae67b43f60f24d",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">3.5",
"size": 4960,
"upload_time": "2023-04-23T16:33:44",
"upload_time_iso_8601": "2023-04-23T16:33:44.595354Z",
"url": "https://files.pythonhosted.org/packages/d6/27/17e2824d3499a2ec212e0f296f9355d0ce33286ab0cbf357d7a142d94470/promptcli-2.0.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a1349b90fb40c068532ce543ce7d00ecf401890078ae9bc9070ced3b2592a71b",
"md5": "e1acfbcd6f45b07c9c6b1bedb98e975f",
"sha256": "ef9aff1a1b5daa0478644c9ea41867ac915168138423e57bee2464a8ca1a93a8"
},
"downloads": -1,
"filename": "promptcli-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "e1acfbcd6f45b07c9c6b1bedb98e975f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">3.5",
"size": 4586,
"upload_time": "2023-04-23T16:33:46",
"upload_time_iso_8601": "2023-04-23T16:33:46.480161Z",
"url": "https://files.pythonhosted.org/packages/a1/34/9b90fb40c068532ce543ce7d00ecf401890078ae9bc9070ced3b2592a71b/promptcli-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-23 16:33:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "raiyanyahya",
"github_project": "prompt",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "promptcli"
}
JSON
