ShellSage 项目使用教程

1. 项目目录结构及介绍

ShellSage 是一个开源项目，旨在为系统管理员提供智能终端助手。以下是项目的目录结构及其说明：

• ./.github/：存放 GitHub 工作流文件，用于自动化测试、构建等操作。
• ./lib_name/：项目的主要代码库，包含项目的核心功能。
• ./shell_sage/：项目的主要脚本文件和模块。
• ./tests/：存放项目的测试代码。
• ./docs/：存放项目文档。
• ./examples/：存放使用 ShellSage 的示例脚本。
• ./scripts/：存放项目的辅助脚本，如安装脚本等。
• ./README.md：项目说明文件，包含项目介绍、安装和配置等信息。
• ./LICENSE：项目许可证文件，本项目采用 Apache-2.0 许可。
• ./requirements.txt：项目依赖文件，用于指定项目运行所需的第三方库。
• ./setup.py：项目安装脚本，用于将项目打包成 Python 包。

2. 项目的启动文件介绍

项目的启动文件是 ./shell_sage/shell_sage.py。这个文件定义了 ShellSage 的主类和入口点。以下是启动文件的简要介绍：

# shell_sage.py

class ShellSage:
    def __init__(self, config):
        # 初始化配置
        pass

    def run(self):
        # 运行 ShellSage，处理终端输入
        pass

if __name__ == "__main__":
    # 加载配置文件
    config = load_config()
    # 实例化 ShellSage 并运行
    sage = ShellSage(config)
    sage.run()

3. 项目的配置文件介绍

项目的配置文件位于 ./~/.config/shell_sage/shell_sage.conf。这个文件用于配置 ShellSage 的行为，包括选择 AI 模型提供者、模型、终端历史设置等。以下是配置文件的示例内容：

[DEFAULT]
# 选择你的 AI 模型提供者
provider = anthropic
# 或者 'openai'
model = claude-3-5-sonnet-20241022
# 或者 'gpt-4o-mini' 对于 OpenAI
base_url =
# 留空以使用默认 openai 端点
api_key =
# 留空以默认使用你的 OPENAI_API_KEY 环境变量
# 终端历史设置
history_lines = -1
# -1 为所有历史
# 代码显示首选项
code_theme = monokai
# 语法高亮主题
code_lexer = python
# 默认代码解析器
log = False
# 设置为 true 以默认启用日志记录

通过修改这个配置文件，用户可以根据自己的需求定制 ShellSage 的行为。