https://github.com/cosgroveb/tmux-ai-summarize
Summarize tmux copy-mode selections in a popup with an OpenAI-compatible API.
https://github.com/cosgroveb/tmux-ai-summarize
openai openai-compatible summarization terminal tmux tmux-plugin tpm zsh
Last synced: about 1 month ago
JSON representation
Summarize tmux copy-mode selections in a popup with an OpenAI-compatible API.
- Host: GitHub
- URL: https://github.com/cosgroveb/tmux-ai-summarize
- Owner: cosgroveb
- License: apache-2.0
- Created: 2026-04-13T00:09:40.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-04-13T05:02:14.000Z (about 2 months ago)
- Last Synced: 2026-04-13T05:23:33.824Z (about 2 months ago)
- Topics: openai, openai-compatible, summarization, terminal, tmux, tmux-plugin, tpm, zsh
- Language: Shell
- Size: 46.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tmux-ai-summarize
[](https://github.com/cosgroveb/tmux-ai-summarize/actions/workflows/ci.yml)
Press `S` in copy mode. tmux copies the text. You get an AI summary in a popup.
The popup stays open. Enter copy mode there if you want to copy the summary back out.
## Requirements
- `tmux >= 3.2`
- `zsh`
- `curl`
- `jq`
## Install with TPM
If you already use TPM, add this to `tmux.conf`:
```tmux
set -g mode-keys vi
set -g @plugin 'cosgroveb/tmux-ai-summarize'
set -g @ai-summarize-key 'S'
# set -g @ai-summarize-model 'gpt-5.4-nano' # default
```
If tmux is already running, reload your config:
```sh
tmux source-file ~/.tmux.conf
```
Install the plugin with `prefix` + `I`. From the shell, `~/.tmux/plugins/tpm/bin/install_plugins` does the same thing.
## Usage
Enter copy mode. Select text. Press `S`.
## Settings
Set your API key. Everything else has sensible defaults.
Plugin-specific env vars take priority over `OPENAI_*` vars. `OPENAI_*` vars take priority over tmux options.
- API key:
`TMUX_AI_SUMMARIZE_API_KEY`, then `OPENAI_API_KEY`, then `@ai-summarize-api-key`
- Base URL:
`TMUX_AI_SUMMARIZE_BASE_URL`, then `OPENAI_BASE_URL`, then `@ai-summarize-base-url`, default `https://api.openai.com/v1`
- Model:
`TMUX_AI_SUMMARIZE_MODEL`, then `@ai-summarize-model`, default `gpt-5.4-nano`
- Prompt:
`@ai-summarize-prompt`, default built-in prompt
- Key:
`@ai-summarize-key`, default `S`
Set tmux options in `tmux.conf` with `set -g`:
```tmux
set -g @ai-summarize-api-key 'sk-...'
set -g @ai-summarize-model 'gpt-5.4-nano'
```
## OpenAI-Compatible API
Use any OpenAI-compatible API by setting a different base URL. Default: `https://api.openai.com/v1`.
Set the API root, including `/v1` if your provider expects it.
For a local or proxy API:
```tmux
set -g @ai-summarize-base-url 'http://localhost:8000/v1'
set -g @ai-summarize-api-key 'dummy-key'
```
Same config with env vars:
```sh
export TMUX_AI_SUMMARIZE_BASE_URL='http://localhost:8000/v1'
export TMUX_AI_SUMMARIZE_API_KEY='dummy-key'
```
TODO: Support emacs copy mode too.