My first ever terminal UI! Everything is stored locally on sqlite and written in Go!
- Go
- bubbletea: A Go framework for terminal user interfaces. It's a great framework that makes it easy to create TUIs in Go.
- openai: OpenAI's REST Api
- sqlite: A C library that provides a lightweight disk-based database that doesn't require a separate server process (perfect for terminal apps, in my opinion).
- lipgloss: Style definitions for nice terminal layouts!
- bubbles: Some general use components for Bubble Tea apps!
Please make sure that you expose a OPENAI_API_KEY inside of your environment; we require it to make api calls!
Set up your api key
export OPENAI_API_KEY="some-key" # you would want to export this in your .zshrc
brew tap tearingitup786/tearingitup786
brew install chatgpt-tui
chatgpt-tuiTo get access to the release candidates, install command:
brew install rc-chatgpt-tui
rc-chatgpt-tuiWe provide a config.json file within your directory for easy access to essential settings.
On most Macs, the path is ~/.chatgpt-tui/config.json.
This file includes the URL used for network calls to the TUI,
specified as chatGPTApiUrl: "https://api.openai.com/v1/chat/completions".
Additionally, the systemMessage field is available for customizing system prompt messages.
Tab: *Change focus between panes. The currently focused pane will be highlighted with a pink border.- You can only change focus if Prompt Pane is not in
insert mode
- You can only change focus if Prompt Pane is not in
Ctrl+o: Toggles zen modeCtrl+c: Exit the program
i: Enters insert mode (you can now safely paste messages into the tui)esc: Exit insert mode for the prompt
y: Copies the last message from ChatGPT into your clipboard.Y: Copies all messages from the ChatGPT session into your clipboard.
m: Opens an input dialog to change the model.f: Opens an input dialog to change the frequency of updates.t: Opens an input dialog to set the maximum number of tokens per message.
Ctrl+N: Creates a new session.d: Deletes the currently selected session from the list.Enter: Switches to the session that is currently selected.
Please refer to this guide as you navigate the TUI. Happy exploring!
The SQL db is stored in you your/home/directory/.chatgpt-tui, as well as the debug log. To enable debug mode, export DEBUG=1 before running the program.
 Taranveer (Taran) Bains 📖 🚧 👀 💻 |
 TJ Miller 📖 💻 |