ShellSage安装与配置指南

ShellSage安装与配置指南

1. 项目基础介绍

ShellSage 是一个开源项目，旨在为系统管理员提供智能终端助手，通过理解和分析终端上下文，为 shell 命令、系统管理任务、Git 操作、文件管理、进程处理以及实时问题解决提供智能帮助。

该项目主要使用的编程语言为 Python 和 Jupyter Notebook。

2. 项目使用的关键技术和框架

• Python：作为主要的编程语言，用于实现项目的核心功能。
• Jupyter Notebook：用于项目的文档和示例展示。
• tmux：终端复用软件，ShellSage 通过与 tmux 集成来读取终端上下文。
• 语言模型：如 Claude 或 GPT，用于提供智能的响应和建议。

3. 项目安装和配置

准备工作

在开始安装 ShellSage 之前，请确保您的系统中已安装以下软件：

• Python 3.6 或更高版本
• tmux -pip（Python 包管理器）

安装步骤

1. 安装 ShellSage

   使用 pip 命令直接从 PyPI 安装 ShellSage：

   pip install shell-sage
   

2. 配置 API Key

   根据您选择的模型提供者（默认为 Claude 或可选 OpenAI），您需要设置相应的 API Key。在 shell 中运行以下命令之一：

   对于 Claude：

   export ANTHROPIC_API_KEY=您的Claude API Key
   

   对于 OpenAI：

   export OPENAI_API_KEY=您的OpenAI API Key
   

3. 配置 tmux

   ShellSage 推荐使用特定的 tmux 配置以获得最佳体验。编辑或创建您的 ~/.tmux.conf 文件，并添加以下配置：

   # 启用鼠标支持
   set -g mouse on
   
   # 显示面板 ID 和时间在状态栏
   set -g status-right ' #{pane_id} | %H:%M '
   
   # 保持终端内容可见（对于 neovim 需要）
   set-option -g alternate-screen off
   
   # 启用 vi 模式以便更好地复制/粘贴
   set-window-option -g mode-keys vi
   
   # 改进搜索和复制绑定
   bind-key / copy-mode \;
   send-key ?
   bind-key -T copy-mode-vi y \
   send-key -X start-of-line \;
   send-key -X begin-selection \;
   send-key -X end-of-line \;
   send-key -X cursor-left \;
   send-key -X copy-selection-and-cancel \;
   paste-buffer
   

   完成后，重新加载 tmux 配置：

   tmux source ~/.tmux.conf
   

4. 使用 ShellSage

   ShellSage 是设计在 tmux 会话中运行的。以下是基本的使用命令：

   ssage hi ShellSage
   

   或者将内容管道到 ShellSage：

   cat error.log | ssage explain this error
   

   您还可以通过命令行参数来覆盖配置文件中的设置，例如：

   ssage --provider openai --model gpt-4o-mini "explain this error"
   

完成以上步骤后，您就可以开始使用 ShellSage 来辅助您的终端操作了。在遇到问题时，可以通过查看项目的 GitHub 页面来获取帮助或贡献您的代码。