Repolode
AnswerDotAI

AnswerDotAI/shell_sage

一款基于 tmux 的 AI 命令行助手,可读取终端历史和管道输入,帮助解答 shell 命令与脚本问题。

Star
407
Fork
44
未关闭 Issue
21
最近提交
10天前

这是什么?

ShellSage 是一个终端 AI 助手,通过 `ssage` 命令调用,主要配合 tmux 使用。它会读取当前窗格或多个窗格的终端历史,理解你执行过的命令和出现的错误,然后给出解释、修正后的命令和示例。也可以把命令输出或文件内容通过管道直接交给它分析。

它支持 Claude、GPT、Gemini、DeepSeek、OpenRouter 等多个大模型服务,也可以接入任何 OpenAI 兼容的 API 地址。可选的 bash 工具基于 safecmd 白名单机制,让助手在安全限制下代你执行命令;在获得授权后,它还能查看文件、搜索代码并进行编辑。交互记录可写入 SQLite,助手给出的代码块也能通过快捷键插入到命令行中。

核心功能

  • 01读取 tmux 窗格历史,结合近期命令和报错给出针对性解答。
  • 02支持通过管道传入命令输出或文件内容进行分析。
  • 03兼容 Claude、GPT、Gemini 及 OpenAI 兼容接口等多种大模型。
  • 04可选的 bash 工具带有白名单安全机制,用于执行命令。
  • 05在用户授权下可查看、搜索和修改文件。
  • 06可将交互记录存入 SQLite,并把建议的代码块插入命令行。

适用场景

  • 结合终端历史排查 shell 命令或 find 表达式执行失败的原因。
  • 解读通过管道传入的 journalctl 等日志或命令输出中的错误。
  • 在终端中学习不熟悉的命令、参数和 git 工作流。
  • 在终端内让助手查看文件或在安全限制下执行命令。

快速上手

  1. 1

    从 PyPI 用 pip 安装 ShellSage

    pip install shell-sage
  2. 2

    设置你的 LLM API 密钥(默认使用 Claude)

    export ANTHROPIC_API_KEY=sk...
  3. 3

    运行一条问候测试命令,确认安装成功

    ssage hi

使用前须知

  • 需要付费 LLM 服务商(如 Anthropic 或 OpenAI)的 API 密钥。
  • 最适合在 tmux 中使用,完整的终端上下文依赖 tmux 配置。
  • README 徽章标注为 MIT,而仓库元数据为 Apache-2.0,请查看 LICENSE 文件确认。

收录于专题

标签

常见问题

shell_sage 是什么?
一款基于 tmux 的 AI 命令行助手,可读取终端历史和管道输入,帮助解答 shell 命令与脚本问题。 ShellSage 是一个终端 AI 助手,通过 `ssage` 命令调用,主要配合 tmux 使用。它会读取当前窗格或多个窗格的终端历史,理解你执行过的命令和出现的错误,然后给出解释、修正后的命令和示例。也可以把命令输出或文件内容通过管道直接交给它分析。
shell_sage 可以免费使用吗?用的什么许可证?
shell_sage 以 Apache-2.0 许可证开源。用于商业产品前,请先确认许可证条款。
shell_sage 还在维护吗?
活跃维护中。shell_sage 最近一次提交是在 2026年10月28日。
shell_sage 适合用来做什么?
结合终端历史排查 shell 命令或 find 表达式执行失败的原因。 解读通过管道传入的 journalctl 等日志或命令输出中的错误。 在终端中学习不熟悉的命令、参数和 git 工作流。 在终端内让助手查看文件或在安全限制下执行命令。
shell_sage 怎么安装和运行?
从 PyPI 用 pip 安装 ShellSage: pip install shell-sage 设置你的 LLM API 密钥(默认使用 Claude): export ANTHROPIC_API_KEY=sk... 运行一条问候测试命令,确认安装成功: ssage hi
在哪里获取 shell_sage?
源代码和安装说明在 GitHub 上:https://github.com/AnswerDotAI/shell_sage

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目