3 releases (breaking)
|0.3.0||Apr 4, 2023|
|0.2.0||Mar 28, 2023|
|0.1.0||Mar 27, 2023|
cligpt is a command-line interface for interacting
ChatGPT API from
you can quickly and easily generate text by sending messages to
from your terminal.
Simply provide your
OpenAI API key and the message you want to generate,
cligpt will handle the rest.
Common use cases
- Generate creative writing ideas or brainstorm topics.
- Get assistance with answering questions about specific subjects.
- Draft emails or other professional writing pieces.
- Summarize lengthy texts.
- Translate text between different languages.
From crates.io (recommended)
Once you have Rust and Cargo installed,
you can install
cligpt from crates.io using Cargo:
cargo install cligpt
This will download the necessary dependencies,
and install it in your system.
Once the installation is complete,
you can run
cligpt by typing
cligpt in your terminal.
Directly from GitHub
you can install
cligpt directly from the GitHub repository
using Cargo by running:
cargo install --git=https://github.com/schneiderfelipe/cligpt.git
By cloning the GitHub repository
You can also build
cligpt from source by cloning the GitHub repository
git clone https://github.com/schneiderfelipe/cligpt.git cd cligpt cargo build --release
the binary will be located at
you can install the binary directly instead of just building it.
cargo install --path=. instead of
cargo build --release.
you need to provide your
OpenAI API key
and the message you want to generate.
You can provide the API key using the
or by setting the
OPENAI_API_KEY environment variable.
Here's an example usage:
$ echo 'Hello, ChatGPT!' | cligpt --api-key YOUR_API_KEY Hello there, how may I assist you today?
This will send the message
'Hello, ChatGPT!' to the
ChatGPT API using
your API key and print the generated text to your terminal.
You can also specify additional options to customize the text generation, such as temperature, and the language model to use.
For example, you can set the temperature to 0.9 and use GPT-4:
$ echo 'Hello, ChatGPT!' | cligpt --temperature 0.9 --model gpt4 Hello! How can I help you today? If you have any questions or need assistance, feel free to ask.
In the example above, the API key will be read from the environment.
cligpt supports receiving input only from the standard input:
$ echo "Repeat this message exactly how you read it" | cligpt Repeat this message exactly how you read it.
cligpt also stores a single chat session,
which can be viewed using
$ echo 'What is the capital of France?' | cligpt The capital of France is Paris. $ cligpt show user: What is the capital of France? assistant: The capital of France is Paris.
You can continue a conversation using the stored chat session:
$ echo "What is the city's population?" | cligpt As of 2021, the population of Paris is estimated to be around 2.2 million people. However, the population of the greater Paris metropolitan area, which includes surrounding suburbs and municipalities, is estimated to be around 12 million people. $ cligpt show user: What is the capital of France? assistant: The capital of France is Paris. user: What is the city's population? assistant: As of 2021, the population of Paris is estimated to be around 2.2 million people. However, the population of the greater Paris metropolitan area, which includes surrounding suburbs and municipalities, is estimated to be around 12 million people.
Chat context is managed by truncating the chat in some situations where we're confident we're only deleting irrelevant information. This is a conservative approach, so it might sometimes fail. If you notice issues with the chat context, please file an issue so we can address it.
For more information on available options,
cligpt is released under the MIT License.