Releases: kardolus/chatgpt-cli
ChatGPT CLI v1.5.0
This release introduces significant updates including bug fixes, a breaking change for better API payload handling, and a new feature to improve context management and max token management. Additionally, it includes a migration strategy for existing configurations to smoothly transition to the new context window setting.
What's New
-
New Feature: Introduced
context_window
to limit the size of the context. This replaces the previousmax_tokens
setting for context management, offering more precise control over the memory footprint of conversations (PR #). -
Configuration Migration: For users migrating from an older version,
config.yaml
now automatically updates to usecontext_window
. Ifcontext_window
is not set, it defaults to the value ofmax_tokens
, andmax_tokens
is reset to4096
. This ensures a seamless transition while encouraging users to leverage the new context management feature (PR #).
Bug Fixes
-
--list-threads
No Longer Requires API Key: Fixed a bug where the--list-threads
command unnecessarily required an API key, streamlining the process for listing threads without additional authentication (PR #). -
API Payload Handling (Breaking Change): The
--max-tokens
setting now correctly applies to the payload of the outgoing API call instead of the size of the context. This change may affect existing workflows that rely on the old behavior. Users are encouraged to review their usage and adjust accordingly
Under the Hood
- Refined the README.md formatting for better readability, including updates to the Configuration and Development sections.
- Adjusted client behavior to align with the new
context_window
andmax_tokens
logic, ensuring consistency across API calls. - Updated testing suites to cover the new features and bug fixes, reinforcing the reliability of the release.
How to Update
Using Homebrew (macOS)
brew upgrade chatgpt-cli
Direct Download
For a quick and easy installation without compiling, you can directly download the pre-built binary for your operating
system and architecture.
ChatGPT CLI v1.4.2
Release Notes for chatgpt-cli Version 1.4.2
We are excited to announce the release of chatgpt-cli
version 1.4.2, which introduces an eagerly awaited feature: Command-Line Autocompletion for flags. This update is designed to enhance the user experience by streamlining interactions with the CLI, making it faster and more intuitive to use the chatgpt-cli
.
New Features
- Command-Line Autocompletion: Users can now enjoy autocompletion for command flags, significantly reducing the effort needed to recall and type out full command options. This feature supports multiple shells, including Bash, Zsh, Fish, and PowerShell, ensuring a wide range of compatibility.
How to Enable Autocompletion
-
For Bash, Zsh, and Fish Shells:
Execute the following command in your terminal to activate autocompletion for the current session:. <(chatgpt-cli --set-completions [shell])
Replace
[shell]
withbash
,zsh
, orfish
according to your shell type. -
For PowerShell:
Execute:chatgpt-cli --set-completions powershell | Out-String | Invoke-Expression
Making Autocompletion Persistent
To ensure autocompletion is enabled in every new shell session, add the autocompletion script to your shell's startup file (~/.bashrc
, ~/.zshrc
, config.fish
, or your PowerShell profile).
Bug Fixes and Improvements
- Minor bug fixes and performance enhancements to improve stability and usability.
Getting Started
To get started with version 1.4.2 of chatgpt-cli
, visit our Installation Guide. Existing users can update to the latest version by following the standard update procedures for their specific setup.
We hope you enjoy the enhanced productivity with the new autocompletion feature. As always, we welcome your feedback and contributions to make chatgpt-cli
even better.
How to Update
Using Homebrew (macOS)
brew upgrade chatgpt-cli
Direct Download
For a quick and easy installation without compiling, you can directly download the pre-built binary for your operating
system and architecture.
Thank you for using chatgpt-cli
!
ChatGPT CLI v1.4.1
What's New in chatgpt-cli Latest Release
We're thrilled to announce the latest update to chatgpt-cli
, which brings significant enhancements and new features to improve your CLI experience. This update introduces the ability to manage conversation threads more efficiently with two new flags: --list-threads
for displaying active threads and --set-thread
for specifying the active thread. These enhancements are designed to streamline your workflow and provide you with greater control over your conversational contexts.
New Features
-
Thread Management Made Easy: Navigate through and manage your conversation threads effortlessly with the new
--list-threads
flag. This feature allows you to view all your active threads, clearly indicating the current active thread for better orientation. -
Customize Your Conversation Context: With the
--set-thread
flag, switching between different conversation threads is now seamless. Specify the thread you wish to activate, andchatgpt-cli
will set it as the current context for your session.
Enhancements
-
Improved Documentation: The README has been updated to include instructions and examples for the newly introduced thread management features, providing you with all the information you need to get started.
-
Code Quality Improvements: Under the hood, the
chatgpt-cli
codebase has been refined for better performance and reliability. These improvements ensure a smoother and more stable experience while using the CLI tool.
Getting Started
To start using these new features, update your chatgpt-cli
to the latest version by following the installation instructions provided in our GitHub repository.
Feedback
Your feedback is invaluable to us as we continue to improve chatgpt-cli
. If you have any suggestions or encounter any issues, please don't hesitate to open an issue on our GitHub repository.
How to Update
Using Homebrew (macOS)
brew upgrade chatgpt-cli
Direct Download
For a quick and easy installation without compiling, you can directly download the pre-built binary for your operating
system and architecture.
ChatGPT CLI v1.4.0
New Features
- Configurable Authentication Header and Token Prefix: In this release, we've introduced the ability to configure the authentication header and token prefix. This enhancement provides greater flexibility and control over the authentication process, allowing users to tailor these settings to their specific needs and integrate more seamlessly with various authentication schemes.
Breaking Changes
- Removal of SetAPIKey from the Caller Interface: In an effort to streamline our code and improve the interface design, the
SetAPIKey
method has been removed from the Caller interface (HTTP client). This change may require updates to existing code where theSetAPIKey
method was previously used. Users will need to adjust their implementation to accommodate this change.
How to Migrate
If you're affected by the breaking change with the removal of SetAPIKey
, here are the steps to migrate:
- Review your current usage of the
SetAPIKey
method within the Caller interface. - Adjust your authentication mechanism to use the new configurable authentication header and token prefix, if applicable.
- Ensure that your authentication process aligns with the updated interface and retest your integrations.
Additional Notes
- As always, we recommend testing these changes in a development or staging environment before rolling them out in production.
- Please refer to the updated documentation for detailed information on the new configurable authentication settings and migration steps.
How to Update
Using Homebrew (macOS)
brew upgrade chatgpt-cli
Direct Download
For a quick and easy installation without compiling, you can directly download the pre-built binary for your operating
system and architecture.
We appreciate your support and feedback as we continue to improve our software. Please reach out if you encounter any issues or have suggestions for future releases.
ChatGPT CLI v1.3.4
We're excited to introduce new configuration options to give you more control over your GPT model interactions.
New Features:
-
Temperature Configuration: Adjust the randomness of the output. Values range between 0 and 2.0, with the default set to 1.0. Higher values, like 0.8, make the output more random, whereas lower values, like 0.2, make it more deterministic.
-
Frequency Penalty: This setting, ranging from -2.0 to 2.0 (defaulting to 0), allows you to penalize tokens based on their existing frequency in the text. Positive values decrease the model's likelihood to repeat the same line verbatim.
-
TopP (Nucleus Sampling): An alternative to temperature sampling. The model considers the tokens with
top_p
probability mass. So, setting it to 0.1 means only the tokens comprising the top 10% probability mass are considered. Defaults to 1. -
Presence Penalty: This value, ranging from -2.0 to 2.0 (defaulting to 0), lets you penalize tokens based on whether they've appeared in the text so far. Positive values encourage the model to discuss new topics.
How to Use:
Update your configuration settings with the new options to take advantage of these features.
Feel free to adjust the content as needed to match your project's style and conventions!
How to Update
Using Homebrew (macOS)
brew upgrade chatgpt-cli
Direct Download
For a quick and easy installation without compiling, you can directly download the pre-built binary for your operating
system and architecture.
Thank you for your continued support. As always, we appreciate feedback and suggestions to make our tool even better!
ChatGPT CLI v1.3.3
In this release, we've enhanced the visibility of error messages for non-2XX HTTP responses. Previously, only the error type was displayed. With this update, you'll also see a more descriptive error message.
How to Update
Using Homebrew (macOS)
brew upgrade chatgpt-cli
Direct Download
For a quick and easy installation without compiling, you can directly download the pre-built binary for your operating
system and architecture.
ChatGPT CLI v1.3.2
New Features
- Configurable Role: You are now able to configure the role of your chatgpt-cli. By default, the role is "You are a helpful assistant". This feature provides chatgpt-cli with more flexibility and adaptability to suit your particular needs.
Dependency Updates
In this new version, we have updated several dependencies to ensure you are using the latest and most secure versions. Although these updates often go unnoticed, they are an essential part of maintaining the health of chatgpt-cli.
How to Update
Using Homebrew (macOS)
brew upgrade chatgpt-cli
Direct Download
For a quick and easy installation without compiling, you can directly download the pre-built binary for your operating
system and architecture.
ChatGPT CLI v1.3.1
In this release, our efforts have largely been focused on improving the interactive mode for a better user engagement experience. Here are the key changes:
Features:
-
Interactive Mode Instructions: Users are now clearly briefed on how to exit interactive mode. Two ways have been implemented - the
exit
command and the universalCtrl+C
action. -
Timestamp on Messages: For better tracking and reference, timestamps are now printed for each query in interactive mode. The timestamp corresponds to when a user finishes typing their query.
-
Exit Feedback: In response to user actions to exit interactive mode, the program now responds with a friendly "Bye!" message.
How to Update
Using Homebrew (macOS)
brew upgrade chatgpt-cli
Direct Download
For a quick and easy installation without compiling, you can directly download the pre-built binary for your operating
system and architecture.
ChatGPT CLI v1.3.0
Release Notes
New Features
-
Per Thread Contexts: In this release, we're introducing per-thread contexts for the ChatGPT CLI. Now, each thread can maintain its own unique context, providing an experience similar to the one users are familiar with on the OpenAI website. This makes it even easier to manage multiple chat sequences or use cases at the same time.
You can specify a thread by setting the
thread
option in your configuration or by using the--thread
flag. If no thread is specified, the application defaults to using the thread nameddefault
. -
Clear History Flag: Want to start a new conversation in the same thread without the baggage of previous interactions? The
--clear-history
flag allows you to easily clear the history of a specific thread.
Improvements
-
Improved Configuration Section: Our README now includes a detailed table explaining each configuration option, its default value, and how to override it.
-
Enhanced README: We have made several updates to our README to provide clearer instructions and more comprehensive information about the application's features.
Bug Fixes
- A number of minor bug fixes and performance improvements.
Remember to check the updated README for more detailed information about these new features and improvements. As always, we welcome your feedback and suggestions for future releases. Enjoy chatting with GPT-3!
How to Update
Using Homebrew (macOS)
brew upgrade chatgpt-cli
Direct Download
For a quick and easy installation without compiling, you can directly download the pre-built binary for your operating
system and architecture.
ChatGPT CLI v1.2.0
Release notes
We are pleased to announce the latest release of the ChatGPT CLI. This update provides enhanced configuration options to optimize your user experience.
Enhanced Configuration
-
Layered Configuration: ChatGPT CLI now supports a layered configuration system for a more flexible setup. The order of precedence for these configurations is: default values, values from the
config.yaml
file, and environment variables. -
Default Configuration: We've included default values for
name
,api_key
,model
,max_tokens
,url
,completions_path
,models_path
, andomit_history
. These defaults ensure a smooth user experience right out of the box. -
User Configuration: You can easily override the default settings by specifying your preferences in the
config.yaml
file located in your home directory. -
Environment Variables: For more immediate and flexible changes, environment variables can be used to overwrite default and user-defined values.
-
Configuration Display: The
--config
or-c
flag is introduced to display the current configuration. It's a quick way to check your settings without having to manually open the configuration files.
New Quick Configuration Flags
To enhance your convenience, we've introduced two new flags to allow for quick modification of the model
and max_tokens
parameters in your user configured config.yaml
. These flags are --set-model
and --set-max-tokens
. For instance, updating the model can be done using the following command:
chatgpt --set-model gpt-3.5-turbo-16k
These quick configuration options enable rapid changes to key settings, optimizing the adaptability of the ChatGPT CLI to your needs.
Your feedback is valuable to us! Please continue to share your experiences and suggestions.
How to Update
Using Homebrew (macOS)
brew upgrade chatgpt-cli
Direct Download
For a quick and easy installation without compiling, you can directly download the pre-built binary for your operating system and architecture.