kardolus/chatgpt-cli

✨ New Features

• Configurable HTTP client timeout (`http_timeout`)
• Added a new configuration option to control the HTTP client timeout (in seconds), allowing better support for slow or local models and environments with variable latency.
• Supports setting the timeout to `0` for no timeout.
• Code references:
• `config/config.go` (new `HTTPTimeout` field)
• `cmd/chatgpt/main.go` (new config wiring and `set-http-timeout` support)
• `api/http/http.go` (HTTP client now uses configured timeout)
• `README.md` (documented new setting)

📦 Improvements

• HTTP client behavior is now configurable rather than fixed
• Replaces the previously hardcoded timeout with a value driven by user configuration, improving flexibility across different runtime environments.
• Code reference: `api/http/http.go`
• Expanded test coverage for HTTP configuration
• Added tests to verify timeout behavior (configured timeout and default behavior).
• Code reference: `api/http/http_test.go`

🐛 Bug Fixes

• No user-facing bug fixes identified beyond the shift from a hardcoded HTTP timeout to a configurable value.

📋 Other Changes

• Documentation update
• Added `http_timeout` to the configuration/environment variable documentation table.
• Code reference: `README.md`

📦 Upgrade Notes

• Homebrew (recommended):
• Run: `brew upgrade chatgpt-cli`
• Direct download:
• Download the prebuilt binaries for your specific OS from the project’s release artifacts and replace your existing `chatgpt` executable.

✨ New Features

• Capped in-memory transcript and prompt history (with truncation banner)
• Introduced a new `TranscriptBuffer` utility to store agent transcripts and prompt history with a strict maximum size and a visible `…(truncated)` banner when older content is dropped.
• Integrated into `BaseAgent` as `Transcript` and `PromptHistory`, enabled by default with conservative limits and configurable via:
• `core.WithTranscriptMaxBytes(n)`
• `core.WithPromptHistoryMaxBytes(n)`
• Code references:
• `agent/core/transcript_buffer.go` (new)
• `agent/core/base_agent.go`
• + 16 more

📦 Improvements

• Agent runs now capture structured transcripts for easier debugging
• Both Plan-and-Execute and ReAct agents now:
• reset transcript/history at the start of each run
• record key lifecycle events (goal, plan steps, prompts, raw LLM output, actions, outcomes, final result)
• This provides consistent, machine-readable traces while keeping memory usage bounded.
• Code references:
• `agent/planexec/plan_execute_agent.go`
• `agent/react/react_agent.go`
• + 8 more

🐛 Bug Fixes

• Prevent transcript/prompt history accumulation across agent runs
• Agents explicitly reset buffers at the start of `RunAgentGoal`, eliminating “leftover” content leaking into subsequent runs.
• Tests added to prevent regressions.
• Code references:
• `agent/planexec/plan_execute_agent.go`, `agent/planexec/plan_execute_agent_test.go`
• `agent/react/react_agent.go`, `agent/react/react_agent_test.go`
• Hardened config persistence to reduce risk of partial/corrupted writes
• Config writes are now:
• + 6 more

📋 Other Changes

• Tighter default filesystem permissions for sensitive data
• Log dir permissions: `0700` (was `0755`)
• `agent/core/log.go`
• Config file writes: `0600` (was `0644`)
• `cmd/chatgpt/main.go` (config save)
• `config/store.go` (atomic write defaults/preserve)
• CLI interactive history file: `0600` (was `0644`)
• `cmd/chatgpt/utils/utils.go`
• + 10 more

📦 Upgrade Notes

• Homebrew (recommended):
• Run:
• ```bash
• brew upgrade chatgpt-cli
• ```
• Direct download:
• Download the prebuilt binary for your specific OS/architecture from the project’s release artifacts, then replace your existing `chatgpt-cli` binary with the new one (ensure it is executable and on your `PATH`).

✨ New Features:

• Enhanced Diff Application with Fuzzy Matching:
• Introduced a new feature that improves how diffs are applied by allowing for "fuzzy" matches around preferred indexes. This feature aims to increase the robustness of applying patches where multiple matching contexts exist.
• Code reference: `unified_diff.go`, `unified_diff_test.go`

📦 Improvements:

• Improved Error Messaging:
• Updated error messages to include more contextual information, such as diff line numbers. This enhancement helps in diagnosing issues more effectively.
• Code reference: `unified_diff.go`
• Refactor and Cleanup:
• Code refactoring to improve readability and maintainability, focusing on the diff utilities module.
• Code reference: `unified_diff.go`, `unified_diff_test.go`

🐛 Bug Fixes:

• Patch Context Matching Issues:
• Resolved bugs where patch application would fail due to context mismatches. Now, the application logic correctly identifies and matches the context even in complex scenarios.
• Code reference: `unified_diff.go`, `unified_diff_test.go`

📋 Other Changes:

• Test Suite Expansion:
• Added numerous test cases to thoroughly validate the new fuzzy diff application logic, ensuring correctness across various scenarios.
• Code reference: `unified_diff_test.go`
• Removed Obsolete Assets:
• Deleted redundant `agent.gif` files from the repository to reduce clutter.
• Code reference: Removed `agent.gif`

📦 Upgrade Notes:

• The release version v1.10.9 introduces improvements and features requiring a system update. You can update to the latest version using one of the following methods:
• Run `brew upgrade chatgpt-cli`, if you are using Homebrew.
• Alternatively, download the binaries directly from our [official releases page](https://example.com/releases) for your specific operating system.
• We hope you enjoy these improvements and appreciate your support and feedback as we continue to enhance our software.

✨ New Features

• Enhanced ReAct Agent Logic:
• Implemented improved iterative reasoning and action mechanisms.
• The agent now recovers more gracefully from models producing invalid JSON in response.
• Enhanced in-band recovery and error messaging for better user interaction.
• Code reference: `agent/react/react_agent.go`

📦 Improvements

• Code Refactoring:
• The codebase has been reorganized for greater modularity, splitting different logical parts into dedicated packages (such as `core`, `planexec`, `react`, and `tools`).
• Clear separation of concerns, improving both readability and maintainability.
• Code reference: Multiple files under `agent/`, `tools/`, and `core/` directories.
• Policy Enforcement Updates:
• Improved safety checks within the agent policy model.
• Enhanced context-specific guidance to prevent undesired actions.
• Code reference: `agent/core/policy.go`
• + 4 more

🐛 Bug Fixes

• Tool Integration:
• Fixed issues where file operations might not respect path constraints properly.
• Addressed shell tool command handling errors, particularly with variadic arguments.
• Code reference: Various files within `tools/`
• Template Processing:
• Resolved issues with Go template rendering within agent steps, reducing the occurrence of template syntax errors.
• Code reference: `agent/planexec/template_step.go`
• Compatibility and Resilience:
• + 3 more

📋 Other Changes

• Testing Enhancements:
• Expanded unit test coverage to validate new behaviors and ensure system robustness against unexpected input.
• Increased resilience against external dependencies changes.
• Code reference: Various test files under `agent/planexec/` and `agent/react/`

📦 Upgrade Notes

• To upgrade to the latest version of `chatgpt-cli`, you may use the following methods:
• Using Homebrew:
• ```bash
• brew upgrade chatgpt-cli
• ```
• Direct Download:
• Download the appropriate binaries for your operating system from the [releases page](https://github.com/yourrepo/chatgpt-cli/releases) of the project.
• Ensure to back up any configuration files or essential data before you upgrade, especially if you have custom configurations in place.

✨ New Features

• Patch and Replace File Operations: Introduced `PatchFile` and `ReplaceBytesInFile` methods on the `Files` interface to allow more efficient in-place file modifications without needing to read the entire content.
• `PatchFile` Method: Applies a unified diff to a file.
• `ReplaceBytesInFile` Method: Replaces byte patterns with new data in a file, supporting controlled occurrences.

📦 Improvements

• Unified Diff Parsing: Enhanced diff parsing capability with robust handling of edge cases and strict adherence to unified diff standards.
• Error Handling in Operations: Improved error messages and handling, particularly in `PatchFile` and `ReplaceBytesInFile`, making the operations more resilient and informative when issues are encountered.
• Logging Improvements: Adjustments to log file creation and opening process to truncate files instead of appending to existing ones, leading to cleaner log management.

🐛 Bug Fixes

• Policy Enforcement Adjustments: Correct handling of file operation permissions in policies, fixing issues where certain operations could be allowed or denied incorrectly based on configuration.
• OutcomeError Handling: Modified behavior to surface errors within the system through `OutcomeError`, allowing agents to notice and react to changes or anomalies during execution.

📋 Other Changes

• Integration and Unit Test Expansions: Added comprehensive tests for newly implemented file operations ensuring reliability and correctness through various scenarios.
• Refactorings in `react_agent.go`: Cleaned up the logic for running actions, ensuring better readability and maintainability.
• Runtime Enhancements: Minor runtime structures and logic updates for more efficient running of agent goals and budget management.

📦 Upgrade Notes

• To upgrade to v1.10.7, you can use Brew or directly download binaries:
• Via Homebrew: Execute `brew upgrade chatgpt-cli` in your terminal.
• For a direct download, obtain the binaries specific to your operating system from the official release page.
• Ensure your configuration settings in `config.yaml` are updated according to any newly introduced options if applicable.

✨ New Features

• Enhanced Logging System:
• Introduced the ability to sync logs manually for both human-readable and debug logs using new sync functions.
• Modified logger output to better distinguish between transcript (plain text) and debug (JSONL) formats.
• Code references: `agent/log.go`, `agent/agent.go`

📦 Improvements

• Code Refactoring for Logging:
• Adapted `agent.go` to utilize `zapcore.NewTee` for simultaneous logging to the terminal and to a transcript file, enhancing the readability and accuracy of the logs during operations.
• Improved the efficiency of log management by ensuring that syncing operations are embedded within the logger's base options.
• Code references: `cmd/chatgpt/main.go`, `agent/log.go`
• Documentation Update:
• Expanded the `AGENTS.md` file with clearer instructions and more detailed project layout explanations to aid developers in contributing effectively.
• Code reference: `AGENTS.md`

🐛 Bug Fixes

• Testing and Mocks Update:
• Rectified unnecessary clock expectations in test cases, ensuring a more accurate and simplified test environment.
• Code references: `agent/react_agent_test.go`

📋 Other Changes

• Testing Enhancements:
• Upgraded test routines by integrating `sclevine/spec` and `gomega` conventions, safeguarding that both unit and integration tests conform to a standard format.
• Code references: `agent/react_agent_test.go`

📦 Upgrade Notes

• To upgrade to the latest version of the chatgpt-cli, follow these steps:
• If you have Homebrew installed, run the command: `brew upgrade chatgpt-cli`
• Alternatively, you can directly download the precompiled binaries appropriate for your operating system from our release page.
• Thank you for using chatgpt-cli!

✨ New Features

• Repetition Guard for ReAct Agent:
• Introduced a new mechanism to prevent repetitive actions in the ReAct agent, enhancing decision-making and reducing redundant command executions.
• Code reference: `agent/react_agent.go`

📦 Improvements

• Enhanced Action Type Handling:
• Improved the handling of action types in the ReAct agent, now supporting shorthand notation for tools like ‘file’, ‘shell’, and ‘llm’.
• This update makes the agent more robust and ensures that incorrect shorthand usage leads to actionable errors.
• Code reference: `agent/react_agent.go`

🐛 Bug Fixes

• Fixed Validation for Inconsistent Shorthand Usage:
• Corrected an issue where using inconsistent shorthand action types with tools would not validate correctly, potentially leading to execution errors.
• Code reference: `agent/react_agent.go`

📋 Other Changes

• Documentation Overhaul:
• The `AGENTS.md` document has been significantly condensed and rewritten to provide clear guidance and structured information for both contributors and users regarding how to work with the CLI application.
• Code reference: `AGENTS.md`
• Testing Enhancements:
• Added comprehensive tests for new functionality in the ReAct agent to ensure that changes adhere to expected standards and behaviors.
• Code reference: `agent/react_agent_test.go`

📦 Upgrade Notes

• To upgrade to version v1.10.5, you can use the following methods:
• With Homebrew:
• ```
• brew upgrade chatgpt-cli
• ```
• Direct Download:
• Visit the [release page](https://github.com/kardolus/chatgpt-cli/releases) to download binaries for your specific operating system.

✨ New Features

• AGENTS.md Documentation:
• Added a comprehensive `AGENTS.md` file outlining the architecture and usage of the ChatGPT CLI, including experimental agent modes like ReAct and Plan/Execute.
• This document serves as an orientation guide for automated agents and contributors, detailing the repository's structure and core functionalities.
• Proof of Concept Image:
• A new image (`poc.png`) has been added to the `cmd/chatgpt/resources/` directory to support visualization needs for development and promotional purposes.

📦 Improvements

• ReAct Agent Logic Refinement:
• Enhanced the parsing logic of the ReAct agent to improve JSON object extraction, ensuring more reliable interpretation of responses.
• Updated CRITICAL RULES for JSON response consistency, emphasizing single-action responses and clear formatting guidelines.

🐛 Bug Fixes

• JSON Parsing in ReAct Agent:
• Fixed a bug in the ReAct agent that incorrectly parsed JSON strings, leading to potential errors during agent operation. Refined the error handling to provide more descriptive feedback when parsing fails.

📋 Other Changes

• Refactored Agent Execution Flow:
• Streamlined the code execution path within the `runAgent` function by removing redundant logger initializations and improving the layout of debugging logs.
• Testing Adjustments:
• Updated unit tests (`react_agent_test.go`) to ensure they align with new parsing error messages, strengthening overall test coverage and reliability.

📦 Upgrade Notes

• To upgrade to this release:
• Use Homebrew: Run `brew upgrade chatgpt-cli` in your terminal.
• Alternatively, download the latest binaries directly for your operating system from the releases page.

✨ New Features

• Agent Mode:
• ReAct Mode: The new default mode that iteratively uses reasoning and acting (think→act→observe) to accomplish tasks.
• Plan/Execute Mode: Generates an entire plan first and then executes the steps sequentially. This workflow is designed for more complex, multi-step tasks.
• Agent Configuration: Enhanced configuration options to define the agent's behavior, budgets, and policies.
• Logging and Reporting: Detailed execution logs are now generated for agent operations, stored in a dedicated directory for easy access and review.

📦 Improvements

• Enhanced Shell and File System Operations:
• Expanded shell command and file operation capabilities and safety controls to prevent unintended access or modification of important data.
• Performance Optimizations:
• Quickened response time for iterative tasks through refined logic and improved resource handling.

🐛 Bug Fixes

• Command Handling: Resolved issues where commands or file operations would fail under specific conditions due to policy limitations.
• Template Parsing: Fixed errors in handling templates that affected task execution reliability.

📋 Other Changes

• Updated Smoke Test Scripts: More extensive automated testing has been introduced to ensure the robustness of new features, ensuring broader compatibility and reliability.
• Refactoring for Maintainability: Code has been refactored to improve readability and maintainability, incorporating community feedback and code improvements.

📦 Upgrade Notes

• How to Update:
• If you installed `chatgpt-cli` via Homebrew, simply run: `brew upgrade chatgpt-cli`.
• Alternatively, download the binaries directly from [Github Releases](https://github.com/kardolus/chatgpt-cli/releases) for your specific operating system.

📋 Changes

• Web search (opt-in): Enable compatible models (gpt-5 family, non “-search” variants) to fetch live web data during a query.
• How to enable: --web and --web-context-size [low|medium|high], or set web and web_context_size in config.
• Implementation details: Automatically routes via the Responses API and injects a web_search tool with search_context_size.
• Compatibility: Not supported by realtime models and blocked for non-gpt-5 or gpt-5-search models.
• Code references: api/client/llm.go, api/responses.go, cmd/chatgpt/main.go, README.md, docs/chatgpt_api.md
• Capability-driven request shaping:
• Added capability flags: SupportsTopP, SupportsWebSearch, IsRealtime.
• Temperature and top_p are now included conditionally based on model support (e.g., top_p omitted for gpt-5).
• + 30 more

📋 Changes

• MCP over STDIO:
• Added a new MCP transport that communicates with MCP servers via stdio, enabling invocation of tools from local subprocesses (e.g., Python-based FastMCP).
• New endpoint format: --mcp "stdio:<command>", for example:
• --mcp "stdio:python test/mcp/stdio/mcp_stdio_server.py"
• Code references: api/client/mcp.go (MCPStdioTransport), test/mcp/stdio/*
• Unified MCP transport factory:
• Introduced NewMCPTransport, which automatically selects the correct transport based on the endpoint scheme (http/https or stdio).
• Code reference: api/client/mcp.go
• + 42 more

📋 Changes

• MCP session management with on-disk cache:
• Automatic MCP session initialization, reuse, and rotation via a new SessionTransport layer.
• Sessions are cached per-endpoint in a filesystem-backed store to reduce round trips and latency between CLI invocations.
• Cache location defaults to ~/.chatgpt-cli/cache/mcp/sessions and can be customized via OPENAI_CACHE_HOME.
• Code references: api/client/mcp.go, cache/*, internal/utils.go, cmd/chatgpt/main.go
• New Makefile targets for local MCP testing:
• mcp-http: Run a local FastMCP HTTP server (JSON responses).
• mcp-sse: Run a local FastMCP SSE server (text/event-stream).
• + 51 more

📋 Changes

• Provider‑agnostic MCP over HTTP(S):
• The CLI now speaks Model Context Protocol (MCP) via JSON‑RPC over HTTP(S), without hardcoding providers.
• New flags:
• --mcp: MCP endpoint URL (e.g., http://127.0.0.1:8000/mcp)
• --mcp-tool: Tool name to invoke on the MCP server
• --mcp-header: Repeatable HTTP headers for auth/session (e.g., Authorization: Bearer …, Mcp-Session-Id: …)
• --param / --params: Tool arguments (as key=value pairs or raw JSON)
• MCP tool results are injected into the active thread as an assistant message prefixed with [MCP: <tool-name>].
• + 46 more

📋 Changes

• Auto shell title support:
• Added a new configuration option auto_shell_title to automatically set the terminal title to the current thread name during interactive sessions (TTY-only; silently skipped in non-TTY).
• Config and CLI flag support:
• Config key: auto_shell_title
• CLI flag: --set-auto-shell-title / set-auto-shell-title
• Code reference: cmd/chatgpt/main.go, config/config.go, README.md
• Interactive “multiline” toggle command:
• You can now toggle multiline input on/off while in interactive mode by typing the command multiline.
• + 40 more

📋 Changes

• Support for custom HTTP headers on all API requests:
• Load API key from a file:
• Enhanced debug output:
• Documentation updates:
• Dependency updates:
• Header handling correctness:
• Testing improvements:
• Minor refactors:
• + 7 more

📋 Changes

• Configuration targeting via --target:
• Quickly switch between multiple configurations by loading config.<target>.yaml (e.g., config.perplexity.yaml, config.azure.yaml).
• Useful for managing different providers or workflows without editing your default config.
• Code reference: cmd/chatgpt/main.go, README.md
• Configurable user agent header:
• New user_agent option lets you customize the User-Agent header for API requests (default: chatgpt-cli).
• Code reference: README.md
• Early flag parsing:
• + 23 more

✨ New Features

• Expanded model compatibility for --effort:
• The --effort flag is now supported for gpt-5 models in addition to o1-pro.
• Code reference: cmd/chatgpt/utils/utils.go, cmd/chatgpt/utils/utils_test.go
• 302.AI support (documented and tested):
• Added configuration guidance and environment variable (AI302_API_KEY) for using 302.AI.
• Code reference: README.md

📦 Improvements

• Simplified provider configuration docs:
• Azure and Perplexity examples streamlined to essential values with clearer API key guidance.
• Added 302.AI configuration section and API reference link.
• Code reference: README.md
• Robust history parsing:
• Gracefully returns an empty list when a history thread file does not exist.
• Safely handles non-string content entries to avoid type assertion errors.
• Code reference: history/manager.go, history/manager_test.go

🐛 Bug Fixes

• History manager stability:
• Treats missing history files as empty threads instead of failing.
• Prevents potential panics by checking content types before appending user messages.
• Code reference: history/manager.go, history/manager_test.go

📋 Other Changes

• Test enhancements:
• Added coverage for gpt-5 effort compatibility and missing-thread behavior.
• Minor test readability improvements.
• Code reference: cmd/chatgpt/utils/utils_test.go, history/manager_test.go
• Documentation updates:
• Updated compatibility statement to include 302.AI and added API reference link.
• Code reference: README.md

📦 Upgrade Notes

• Homebrew: brew upgrade chatgpt-cli
• Direct download: Download the latest binaries for your OS from the releases page and replace your existing binary.
• No breaking changes. Existing configurations continue to work. If using 302.AI, set AI302_API_KEY or add api_key to your config as documented.

✨ New Features:

• Support for GPT-5 Models:
• Added support for the new GPT-5 model, enhancing the system's capabilities with improved language understanding and response generation.
• Integrated into the response-fetching mechanism for efficient data handling.
• Code references: `api/client/client.go`, `api/http/http.go`, `api/responses.go`.

📦 Improvements:

• Functionality Update in Client Module:
• Enhanced the `CreateResponsesRequest` function to handle streaming and additional parameters like temperature and top_p for customizable outputs.
• Improved the `GetCapabilities` function to recognize features supported by different models.
• Code reference: `api/client/client.go`.
• Streamlined HTTP Response Processing:
• Introduced a specialized handler for different streaming endpoints, enabling better management of Server-Sent Events (SSE).
• Legacy and new streams are now processed according to endpoint specifics, enhancing system reliability.
• Code reference: `api/http/http.go`.

🐛 Bug Fixes:

• Resolved Function Consistency Issues:
• Corrected the case inconsistency in function calls related to model capabilities (`getCapabilities` to `GetCapabilities`).
• Code reference: `api/client/client.go`.
• Improvement in Test Stability:
• Revised test cases to accommodate the addition of the GPT-5 model, ensuring tests are model-agnostic.
• Fixed potential test failures due to hardcoded model checks.
• Code reference: `api/client/client_test.go`, `api/http/http_test.go`.

📋 Other Changes:

• Code Refactoring:
• Deprecated old capability function to promote the new `GetCapabilities`, aligning with the updated model handling architecture.
• General code cleanup to remove deprecated model handling variables and improve readability.
• Improved documentation for API usage in `chatgpt_api.md`.
• Code reference: `api/client/client.go`, `docs/chatgpt_api.md`.

📦 Upgrade Notes:

• Users can upgrade to this version using the following methods:
• Homebrew Users: Run `brew upgrade chatgpt-cli`.
• Direct Download: Visit the release page to download binaries compatible with your operating system.

📦 Improvements:

• Update Default Model Configuration:
• Updated the default model configuration and integration to utilize GPT-4o, ensuring improved AI model interaction.
• Adjustments made in: `cmd/chatgpt/main.go`, `api/client/client_test.go`.
• CLI Resource Enhancements:
• Altered visual settings of the CLI demonstration resources to improve user experience, such as font size, width, and theme.
• Code reference: `cmd/chatgpt/resources/chatgpt-cli.tape`.

🐛 Bug Fixes:

• Corrected Model Handling in Tests:
• Updated the expected results in integration tests to match the new default model selections, ensuring test validity and stability.
• Code references: `test/integration/integration_test.go`, `api/client/client_test.go`.

📋 Other Changes:

• Resource File Updates:
• Minor changes applied to binary resource files.
• Code reference: `cmd/chatgpt/resources/vhs.gif`.

📦 Upgrade Notes:

• To upgrade to version v1.8.6, you can use one of the following methods:
• Using Homebrew: Run the command `brew upgrade chatgpt-cli` in your terminal.
• Direct Download: Download the appropriate binary for your operating system from our [release page](#).
• Please update your configurations to accommodate any changes, especially if you utilize custom model settings. Enjoy the enhanced capabilities of the GPT-4o model in this release!

✨ New Features

• Enhanced History Management: This version introduces robust handling of command history in interactive mode. Users can now enjoy better tracking of their inputs and outputs, allowing for more accurate and efficient use of command history during sessions.

📦 Improvements

• Config Section Update: The "Configuration" section has been renamed to "Config" in the documentation for easier navigation.
• Dependency Updates: Various dependencies have been updated to their latest versions for improved performance and stability, including:
• Upgraded `github.com/onsi/gomega` to v1.38.0.
• Upgraded to the latest versions of `go.uber.org/zap` and `github.com/go-viper/mapstructure/v2`.

🐛 Bug Fixes

• Interactive Mode Fixes: Fixed issues related to command history not saving correctly in interactive mode. This makes it seamless to resume sessions with previously used commands readily available.
• Corrected History Parsing: Resolved inaccuracies in parsing user command history, ensuring that only relevant user entries are returned.

📋 Other Changes

• Codebase Refactoring: Performed code clean-up for better organization, enhancing maintainability and future development processes.
• Testing Improvements: Introduced new unit tests for better validation of the history management system, ensuring reliability and accuracy in history handling.

📦 Upgrade Notes

• We thank you for your support and welcome your feedback on these improvements!

✨ New Features:

• Image Generation and Editing:
• Added the capability to generate images based on text prompts using image-capable models like `gpt-image-1`.
• Code Reference: `api/client/client.go`, `cmd/chatgpt/main.go`
• Enabled editing of images with text prompts to modify the input image.
• Code Reference: `api/client/client.go`, `cmd/chatgpt/main.go`
• New API endpoints introduced for image generation and editing.
• Code Reference: `config/config.go`, `config/store.go`

📦 Improvements:

• Command Line Interface (CLI) Enhancements:
• Updated command-line flags to support new image generation and editing features.
• Added `--draw` flag to initiate image creation.
• Code Reference: `cmd/chatgpt/main.go`
• Configuration Enhancements:
• Added `image_generations_path` and `image_edits_path` to the configuration.
• Code Reference: `config/config.go`, `cmd/chatgpt/main.go`

🐛 Bug Fixes:

• Validation Improvements:
• Fixed erroneous behavior when using CLI flags to ensure appropriate usage.
• The `--output` flag now requires `--draw` or `--speak` flags.
• Code Reference: `cmd/chatgpt/utils/utils.go`

📋 Other Changes:

• Documentation Updates:
• Updated API documentation to reflect new image generation and editing capabilities.
• Code Reference: `docs/chatgpt_api.md`
• Test Coverage Enhancement:
• Expanded test cases to cover new image processing functionalities.
• Code Reference: `api/client/client_test.go`, `cmd/chatgpt/utils/utils_test.go`

📦 Upgrade Notes:

• To upgrade to this release, you can use Homebrew or download the appropriate binary directly:
• With Homebrew:
• ```shell
• brew upgrade chatgpt-cli
• ```
• Direct Download:
• Visit the [release page on GitHub](https://github.com/your-repo/chatgpt-cli/releases) and download the binary for your specific operating system.

✨ New Features:

• Model Context Protocol (MCP) Support:
• Introduced MCP support allowing structured, live data injection into chat sessions, initially supporting only Apify integrations.
• Key functionalities include fetching real-time information like weather and injecting it into the chat context.
• Added command-line flags `--mcp`, `--param`, and `--params` for specifying MCP plugin and parameters.
• Code Reference: [README.md](README.md), [api/client/client.go](api/client/client.go), [cmd/chatgpt/main.go](cmd/chatgpt/main.go)

📦 Improvements:

• Code Refactoring and Enhancements:
• Added informative error messages for MCP-related operations, improving error handling and user feedback.
• Updated request header management in the HTTP client for better security and extensibility.
• Code Reference: [api/client/client.go](api/client/client.go), [api/http/http.go](api/http/http.go)
• Documentation and Configuration:
• New documentation for Apify MCP usage includes example API requests and configuration options.
• Separated MCP-related configuration in the command-line interface, enhancing user experience.
• Code Reference: [docs/apify_api.md](docs/apify_api.md)

🐛 Bug Fixes:

• Resolved Header Management Issues:
• Fixed issues with missing or incorrect HTTP headers during network requests, ensuring successful API communication.
• Code Reference: [api/http/http.go](api/http/http.go)
• Corrected Error Handling in Test Cases:
• Enhanced test coverage for MCP context injection to ensure proper handling of response formats and errors.
• Code Reference: [api/client/client_test.go](api/client/client_test.go), [cmd/chatgpt/utils/utils_test.go](cmd/chatgpt/utils/utils_test.go)

📋 Other Changes:

• Code Clean-Up and Test Improvements:
• Added test cases for MCP parsing and parameter validation, ensuring robustness of new feature implementations.
• Optimized parameter parsing logic to handle JSON and key-value pairs efficiently.
• Code Reference: [cmd/chatgpt/utils/utils.go](cmd/chatgpt/utils/utils.go), [cmd/chatgpt/utils/utils_test.go](cmd/chatgpt/utils/utils_test.go)

📦 Upgrade Notes:

• You can upgrade to the new version using Homebrew by executing `brew upgrade chatgpt-cli`.
• Alternatively, download the binaries directly for your specific operating system from the release page.
• Ensure you update your configuration with the new `APIFY_API_KEY` by setting it as an environment variable or in your configuration files.

✨ New Features

• Enhanced History Feature:
• Implemented a mechanism for storing and appending transcriptions to the history log to improve user interaction tracking.
• Code Reference: `api/client/client.go`

📦 Improvements

• Refined Synthesize Speech Command:
• Adjusted the concatenation logic to use `chatContext` for more accurate text-to-speech synthesis from piped content.
• Code Reference: `cmd/chatgpt/main.go`
• Command-Line Interface Commands:
• Added specific flag help for the `--speak` option to enhance user guidance.
• Code Reference: `cmd/chatgpt/main.go`

🐛 Bug Fixes

• No specific bug fixes were included in this release.

📋 Other Changes

• Readme Update:
• Corrected sample command to reflect the removal of obsolete prefixes for better clarity.
• Code Reference: `README.md`
• Test Enhancements:
• Expanded test cases in `client_test.go` to validate changes in history handling and ensure robustness against failed operations.
• Code Reference: `api/client/client_test.go`

📦 Upgrade Notes

• To upgrade to this release, you can either:
• Use Homebrew to upgrade: `brew upgrade chatgpt-cli`
• Directly download the binaries for your specific OS from the [releases page](URL_TO_RELEASE_PAGE).

✨ New Features:

• Transcription Support:
• Introduced the `--transcribe` flag to generate transcripts from audio files.
• Supports a variety of audio formats, including `.mp3`, `.mp4`, `.mpeg`, `.mpga`, `.m4a`, `.wav`, and `.webm`.
• API endpoint used: `/v1/audio/transcriptions`.
• Appropriate CLI usage will allow users to extract text content from audio files.
• Text-to-Speech Support:
• Added the `--speak` and `--output` flags for converting text into speech with TTS model `gpt-4o-mini-tts`.
• Output can be played back directly if `afplay` is installed (macOS), enhancing accessibility.
• + 1 more

📦 Improvements:

• Expanded CLI Capabilities:
• The command-line interface now supports more flexible configuration options using a layered system (default values, `config.yaml`, environment variables).
• Enhanced debug options for better visibility into API interactions.
• Model Capabilities:
• Introduction of a `getCapabilities()` method to dynamically determine model features such as support for temperature and TTS capabilities.
• Modular Endpoints:
• API paths are now more customizable with additions for specific model types, improving integration flexibility.

🐛 Bug Fixes:

• Addressed issues in API endpoint selection logic which previously led to incorrect routing.
• Fixed condition checks related to the `new-thread` flag for the command-line interface.

📋 Other Changes:

• Added significant refactoring in the codebase for better readability and maintainability of various modules, including the `client`, `api`, and `cmd` packages.
• New mock interfaces and test enhancements using `gomock` for robust unit testing and improved CI/CD performance.

📦 Upgrade Notes:

• Update Methods:
• Homebrew Users: Run `brew upgrade chatgpt-cli` to get the latest update.
• Direct Download: You may download available binaries specific to your OS directly from the repository or website.
• Configuration Modification:
• Ensure to update your `config.yaml` to leverage new features and flags introduced in this release.

✨ New Features:

• Audio Support Added:
• *Code reference: `README.md`, `api/client/client.go`*

📦 Improvements:

• Refactoring for File Operations:
• The `ImageReader` type has been generalized to `FileReader`, reflecting the broadened scope to include audio file handling.
• *Code reference: `api/client/client.go`, `api/client/client_test.go`, `api/client/readermocks_test.go`*
• Response Handling Enhanced:
• Improved sorting for model listings to ensure alphabetical order.
• Updated logging to use `go.uber.org/zap` for enhanced logging features and control over output.
• *Code reference: `api/client/client.go`, `api/client/client_test.go`, `internal/logging.go`*

🐛 Bug Fixes:

• Response Conversion Handling:
• Fixed a bug where non-string API responses could cause errors.
• *Code reference: `api/client/client.go`*

📋 Other Changes:

• Command-Line Interface Enhancements:
• Added flags for showing debug information with `--debug`.
• Adjusted various CLI outputs to utilize consistent logging for clearer output.
• *Code reference: `cmd/chatgpt/main.go`*
• Documentation Updates:
• Expanded command examples for new features and general usage.
• *Code reference: `docs/chatgpt_api.md`*
• Dependencies Updated:
• + 3 more

📦 Upgrade Notes:

• To upgrade to this version, users can:
• Use Homebrew: `brew upgrade chatgpt-cli`
• Directly download the binaries for your specific OS from the release page.

✨ New Features

• Contextual Image Support:
• Enabled the ability to handle image inputs via context, supporting both URLs and local file paths to enhance data inputs for image queries.
• Code reference: `api/client/client.go`, `cmd/chatgpt/main.go`

📦 Improvements

• Query and Stream Functionality:
• Revised the Query and Stream methods to accept context, allowing better handling of timeouts, cancellations, and scoping.
• Code reference: `api/client/client.go`, `cmd/chatgpt/main.go`
• Binary Data Handling Optimization:
• Redesigned the logic for handling binary data inputs to streamline operations and prevent adding unnecessary binary data to the command history.
• Code reference: `cmd/chatgpt/utils/utils.go`, `cmd/chatgpt/utils/utils_test.go`

🐛 Bug Fixes

• Error Management:
• Rectified issues with thread and history management, particularly in scenarios where specified threads do not exist or when clearing empty histories.
• Code reference: `config/store.go`, `cmd/chatgpt/main.go`

📋 Other Changes

• Code Refactoring:
• Consolidated and optimized import statements across several packages for better maintainability and performance.
• Code reference: `api/client/client_test.go`, `cmd/chatgpt/utils/utils.go`
• Dependency Updates:
• Updated several Golang module dependencies to their latest versions, ensuring compatibility and leveraging improvements.
• Code reference: `go.mod`, `go.sum`

📦 Upgrade Notes

• To upgrade to this version, you can use the following methods:
• Homebrew: Run `brew upgrade chatgpt-cli` to update to the latest version.
• Direct Download: Alternatively, download the updated binaries for your operating system directly

✨ New Features:

• Binary Data Handling:
• Enhanced support for binary data input in the CLI. Input can now be piped as binary data, and the application will handle it appropriately.
• Code references: `api/client/client.go`, `cmd/chatgpt/main.go`.

📦 Improvements:

• Image Handling Refactoring:
• Refactored image content handling for more efficient operations by introducing `createImageContentFromBinary` and `createImageContentFromURLOrFile` functions.
• Code reference: `api/client/client.go`.
• Utility Enhancements:
• Introduced a new `IsBinary` function for improved detection of binary data within the CLI.
• Extended test coverage to ensure robustness.
• Code reference: `cmd/chatgpt/utils/utils.go`.

🐛 Bug Fixes:

• History Management:
• Fixed a bug where history was modified when binary data was provided to `ProvideContext`, ensuring history remains unchanged in this scenario.
• Code reference: `api/client/client_test.go`.

📋 Other Changes:

• Dependency Updates:
• Upgraded `golang.org/x/exp` and `golang.org/x/sys` modules to newer versions.
• Code references: `go.mod`, `go.sum`.
• Testing and Linting Enhancements:
• Added checks to flag TODOs within the codebase as errors, encouraging cleaner code practices.
• Code reference: `scripts/all-tests.sh`.

📦 Upgrade Notes:

• To upgrade to this version, you can use the command:
• ```
• brew upgrade chatgpt-cli
• ```
• Alternatively, you can directly download the binaries specific to your operating system from the official repository.

✨ New Features:

• Image Support:
• Added the ability to upload images or provide image URLs using the `--image` flag. This feature enhances user interaction by allowing visual content to be processed in queries.
• Note: Image support is model-dependent and may not be available for all models.
• Code references: `api/client/client.go`, `cmd/chatgpt/main.go`

📦 Improvements:

• CLI Enhancements:
• Updated the Makefile to provide better guidance on available commands for testing, building, and deployment.
• Improved context customization options through the configuration system.
• Code reference: `README.md`, `cmd/chatgpt/main.go`, `Makefile`
• Performance Optimizations:
• Refactored token counting functions and added better support for handling different data types within message content.
• Code references: `api/client/client.go`, `api/completions.go`

🐛 Bug Fixes:

• Content Handling Fixes:
• Corrected type assertions for message content to prevent runtime errors when handling JSON responses.
• Code references: `api/client/client.go`, `history/manager.go`

📋 Other Changes:

• Testing and Documentation Updates:
• Updated unit tests to cover new image support capabilities using mocks.
• Documentation refreshed to include instructions for using new image functionalities.
• Code references: `api/client/client_test.go`, `docs/chatgpt_api.md`
• Dependency Updates:
• Updated several Go module dependencies for enhanced stability and performance.
• Code references: `go.mod`, `go.sum`

📦 Upgrade Notes:

• To upgrade to version v1.7.8, you can use one of the following options:
• Homebrew: Run `brew upgrade chatgpt-cli` if you installed via Homebrew.
• Direct Download: Download the binaries directly from the GitHub releases page to match your operating system specifications.

✨ New Features

• Added Command and Output Prompt Colors:
• Introduced the ability to set colors for the command and output prompts in interactive mode. Supported colors include "red", "green", "blue", "yellow", and "magenta".
• Code references: Updates in `README.md` and modifications in `cmd/chatgpt/main.go` and `config/config.go`.

📦 Improvements

• System Role File Option:
• A new `--role-file` flag has been added to allow users to set the system role from a specified file, providing greater flexibility in configuring the chat application.
• Code reference: Modifications in `cmd/chatgpt/main.go`.
• Enhanced ANSI Color Handling:
• Implemented a new utility function `ColorToAnsi` that maps color names to ANSI escape codes, improving console color management.
• Code reference: `cmd/chatgpt/utils/utils.go` added with corresponding tests in `cmd/chatgpt/utils/utils_test.go`.

🐛 Bug Fixes

• No specific bug fixes were highlighted in this release.

📋 Other Changes

• Code Cleanup and Refactoring:
• Removed the `.idea/workspace.xml` and `bin/chatgpt` files from the repository, improving overall repository hygiene.
• Updated `.gitignore` to ensure proper exclusion of editor-specific files and build artifacts.
• Code reference: Modifications in `.gitignore` and file deletions in `.idea/workspace.xml` and `bin/chatgpt`.
• Dependency Updates:
• Upgraded `github.com/magiconair/properties` to v1.8.9 to maintain compatibility and security.
• Code reference: Changes in `go.mod` and `go.sum`.

📦 Upgrade Notes

• To upgrade to version v1.7.7, you can use one of the following methods:
• Homebrew: Run the following command in your terminal:
• ```sh
• brew upgrade chatgpt-cli
• ```
• Direct Download: Alternatively, you can download the binaries for your specific operating system directly from the release page.