chatgpt-cli-tool 1.2.0

Command line interface tool for interacting with ChatGPT using terminal

ChatGPT - Command Line Interface

CLI tool for interacting with ChatGPT using terminal

Requirements

• Python >= 3.8.0
• OpenAI account and valid API key

Installation

Tool can be installed using python3 pip command:

pip install chatgpt-cli-tool

Or you can install it directly form this project after building it:

python build.py

pip install dist/chatgpt-cli-tool-{version}.tar.gz

Configuration

In order to use ChatGPT cli you will first need to register and create an API key on the official OpenAI website.

Then you can configure the tool with your API key using any of the following options:

1. Create an ~/.chatgpt-cli/.env file with variable OPENAI_API_KEY
2. Create an .env file in the working directory with variable OPENAI_API_KEY
3. Set it through environment variable OPENAI_API_KEY
4. Pass it as the first argument when executing this tool (e.g. chatgpt-cli my_api_key)

To see other configurable options for ChatGPT check out .env.example file.

Running the CLI

If you installed the tool using pip, then simply start the cli using any of the following commands:

# interactive chat command template
chatgpt-cli [api_key]

# example with api key
chatgpt-cli my_api_key

# example without api key
chatgpt-cli

# single gpt request command template
gpt-ai [api_key] [query]

# single command example with api key and query argument
gpt-ai my_api_key "What is ChatGPT?"

# single command example with query argument
gpt-ai "What is ChatGPT?"

# single command example with query from stdin
cat question.txt | gpt-ai

# single command example with both query as argument and string input
cat long-story.txt | gpt-ai "sumarize this text in 5 bullet points"

API key argument is optional, but if provided it will override API key defined using environment variables.

License

ChatGPT-cli is MIT licensed.