Releases: kardolus/chatgpt-cli
ChatGPT CLI v1.6.0
Changes
- Error Handling Enhancement:
- Error messages are now printed to stderr instead of stdout. This change improves error logging and handling, making it easier to differentiate between regular output and error messages.
- Updated integration tests to check stderr for error messages, ensuring more robust and accurate test coverage.
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.5.5
Sure, here's a draft for the GitHub release of version v1.5.5:
What's New
- Enhanced Query Functionality: The
Query
function in theclient
package now returns token usage data along with the response content. This allows developers to track usage metrics more effectively. Note that the token usage is only printed when it's used in conjunction with the interactive mode.
Improvements
- Adjusted the function signature and response handling to include token usage, enhancing transparency and control over API usage.
- Updated all relevant call sites and test cases to accommodate the new return type and ensure consistency across the codebase.
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.5.4
This release introduces the --delete-thread
flag, enhancing the thread management capabilities of the ChatGPT CLI. Users can now delete specified threads directly from the command line, making it easier to manage the conversation context dynamically. Below are the details of the updates in this release:
Features
Delete Thread: Added the --delete-thread
flag to allow users to delete specific threads. This addition improves the manageability of threads within the CLI, providing a cleaner and more efficient user experience. The deletion process is idempotent, meaning that attempting to delete non-existent threads will not result in an error, making script integration smoother.
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.5.3
We are thrilled to announce the release of ChatGPT CLI v1.5.3. This update introduces an enhanced interactive mode, leveraging the readline library to provide dynamic prompts and advanced input handling features. With these improvements, users can now enjoy a more intuitive and efficient CLI experience.
What's New
- Enhanced Interactive Mode: We've integrated the readline library to improve the interactive mode significantly. This update brings several key features:
- Dynamic Prompts: The CLI now updates prompts dynamically with the current time and question count, making the interactive sessions more informative.
- Editable Input Lines: Users can edit their input directly in the command line, including moving the cursor, deleting characters, and making corrections as needed.
- Command History: Navigate through the history of entered commands using the arrow keys, allowing for easy repetition and modification of previous queries.
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.5.2
We're excited to announce the release of version 1.5.2 of ChatGPT-CLI!
What's New
Preserving Comments in config.yaml
- Feature Highlight: Our latest update ensures that comments in your
config.yaml
file are preserved after any read-write operations performed by chatgpt-cli. This enhancement is especially useful for users who prefer manually editing their configuration files, providing a more intuitive and user-friendly experience.
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.5.1
We're excited to announce the latest updates to the ChatGPT Command Line Interface (CLI)! This release introduces new features and enhancements that improve customization, flexibility, and ease of use. Here's what's new:
New Feature:
- Adjustable Context Window Size: Users now have the ability to adjust the context window size through the new
--set-context-window
flag. This enhancement allows for more precise control over the amount of conversational context the model considers, enabling users to tailor the chat experience to their specific needs.
Enhancement:
- Improved Configuration Documentation: The README.md file has been updated to reflect these changes, providing clear and concise instructions on how to utilize the new and existing features effectively.
Developer Enhancements:
-
Codebase Improvements: For developers, we've introduced a new variable
contextWindow
in the main.go file, alongside the necessary logic to support the adjustable context window size feature. Additionally, theconfigmanager.go
file has been updated with a new methodWriteContextWindow
, which handles the updating of this setting in the configuration. -
Testing Enhancements: Our commitment to quality and stability is reinforced with updates to the
configmanager_test.go
andintegration_test.go
files, ensuring comprehensive test coverage for the new context window functionality.
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.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.