项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 1969
使用教程
环境要求
- 基于 Unix 的操作系统(Linux 或 macOS)
- 系统已安装 tmux(TmuxAI 唯一必需的外部依赖)
- 若要使用 go install 方式安装,需要已安装 Go 环境
- 使用云模型需自备对应服务商的 API Key(如 OpenRouter / OpenAI / Azure)
安装与启动步骤
-
1安装 tmuxai
README 推荐的快速安装方式,通过官方脚本安装;默认会装到 /usr/local/bin/tmuxai,脚本源码可在 get.tmuxai.dev 查看。
curl -fsSL https://get.tmuxai.dev | bash -
2从 main 分支安装(可选)
想用最新开发版可改用 go install;注意 main 分支比正式发布版稳定性差,适合尝鲜用户。
go install github.com/alvinunreal/tmuxai@main -
3创建配置目录
TmuxAI 从 ~/.config/tmuxai/config.yaml 读取配置,先建好目录再创建配置文件。
mkdir -p ~/.config/tmuxai -
4写入最小配置
在 config.yaml 里添加一个模型配置,provider 可填 openrouter、requesty、openai 或 azure,model 与 api_key 按你的账号填写。
vim ~/.config/tmuxai/config.yaml -
5启动 TmuxAI
在 tmux 会话中直接运行 tmuxai,即可通过快捷键唤起 AI 对话;也可在命令后直接跟初始消息。
tmuxai
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
models.primary.provider | 是 | 指定 AI 服务商:openrouter、requesty、openai 或 azure | openrouter |
models.primary.model | 是 | 指定要调用的模型名称,随服务商不同而不同 | anthropic/claude-haiku-4.5 |
models.primary.api_key | 是 | 服务商的 API 密钥;Bedrock、GitHub Copilot 方式无需填写 | sk-your-api-key |
models.<name>.region | 否 | 仅 AWS Bedrock 使用,指定区域;已设 AWS_REGION 时可省略 | us-east-1 |
models.<name>.aws_profile | 否 | 仅 AWS Bedrock 使用,指定 ~/.aws/credentials 中的命名 profile | default |
如何确认成功
在 tmux 会话中执行 tmuxai,能出现 TmuxAI 对话界面并正常返回模型回复即表示配置成功。
常见问题
Q:不知道用什么模型或服务商怎么办?
A:README 给的最小示例使用 provider: openrouter、model: anthropic/claude-haiku-4.5,把 provider 换成你实际使用的服务商并填入对应 model 和 api_key 即可。
Q:如何临时切换另一个模型配置?
A:用 --model 参数指定配置名,例如 tmuxai --model gpt4 "Write a Go function",或直接 tmuxai --model claude-sonnet。
Q:可以不带 API Key 使用吗?
A:可以。AWS Bedrock 走标准 AWS 凭证链无需 api_key;GitHub Copilot 走 copilot CLI 的 gh 凭证,同样无需 api_key。
Q:怎么让 TmuxAI 只在指定窗格执行命令?
A:用 --exec-pane %3 强制指定执行窗格,用 --read-panes %1,%2 限定读取上下文的窗格;窗格 ID 必须存在于当前 tmux 窗口,且聊天窗格不能作为执行或读取窗格。
Q:如何接入 MCP 服务器?
A:创建 ~/.config/tmuxai/mcp.json,按 stdio、SSE 或 streamable-http 三种传输方式填写 command/url 等字段,启动时 TmuxAI 会自动连接并注入工具定义。
注意事项
- 快速安装脚本默认把二进制装到 /usr/local/bin/tmuxai,如需换路径请先查看脚本源码。
- main 分支包含最新特性但稳定性不如正式发布版本,生产环境建议用官方 Release。
- 配置文件固定路径为 ~/.config/tmuxai/config.yaml,MCP 配置为同目录下的 mcp.json。
- --exec-pane 与 --read-panes 中的窗格 ID 必须存在于当前 tmux 窗口,否则无法生效。
核心亮点
- 与 tmux 深度集成,快捷键唤起,无需离开终端
- 支持自定义 AI 后端,兼容 OpenAI API,灵活接入
- 非侵入式设计,不改变原有 tmux 操作习惯
不足之处
- 仅支持 tmux 环境,对非 tmux 用户无直接用途
- 文档/社区待观察
适用场景
- 在 tmux 分屏中快速查询命令用法或解释报错
- 编写脚本时通过 AI 生成代码片段并直接粘贴
- 远程开发时在 SSH 会话中获取智能辅助
替代项目
Warp、aichat、shell-gpt
下一篇:bia-bob
同类项目推荐
OwnGPT
开源
本地跑起专属GPT,文档问答不泄密
Create Own ChatGPT with your documents using streamlit UI on your own device using G···
FeHelper
开源
装一个扩展,搞定前端日常开发杂活
FeHelper--Web前端助手(Awesome!Chrome & Firefox & MS-Edge Extension, All in one Too···
awesome-chatgpt
开源
找ChatGPT工具,看这份精选清单就够了
A curated list of awesome ChatGPT resources, including libraries, SDKs, APIs, and mo···
unsaged
开源
一个工具包,无缝对接所有主流 AI 模型,聊天更自由。
Open source chat kit engineered for seamless interaction with AI models.
PersonalAssistantChatbot
开源
用语音和视觉打造你的桌面级个人助理
It is a personal assistant chatbot, capable to perform many tasks same as Google Ass···
SecurePay-Visa
开源
用 USDT 开虚拟卡,轻松搞定 ChatGPT 等海外订阅支付
推荐使用usdt支付链接: https://payforcard.com/auth?invite=INV7309B065 ,visa虚拟卡,···
wechaty-puppet-padplus
开源
用iPad协议把微信个人号接入Wechaty,但已弃用
DEPRECATED: One puppet based on iPad protocal for Wechaty
Building-a-Simple-Chatbot-in-Pyt···
开源
用NLTK手写一个简单聊天机器人,快速入门NLP对话。
Building a Simple Chatbot from Scratch in Python (using NLTK)
AppleAI
开源
菜单栏一键聚合所有主流 AI,告别来回切换
Apple AI is a lightweight, privacy‑minded macOS menu bar app that keeps your favori···
