Skip to content

LuShnot/CmdHelper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🐧 Linux Command Expert (RAG & LLM Powered)

Python FastAPI ChromaDB LLM

Linux Command Expert 是一款基于 RAG (检索增强生成) 技术与 豆包大模型 (Doubao-lite-32k) 的智能化 Linux 命令行辅助工具。

它不仅仅是一个简单的命令生成器,更是一个具备 风险意识权威知识库 的专家系统。它能将自然语言需求转化为精准的 Linux 指令,并对每条指令进行风险评估,防止误操作带来的灾难性后果。

🚀 核心能力:自然语言转指令 | 智能风险预警 | RAG 知识库增强 | 中英双语支持


✨ 核心特性 (Features)

  • 🧠 智能意图识别:基于 Doubao-32k 模型,精准理解复杂的运维需求(如“查找占用内存最高的前5个进程”)。
  • 🛡️ 三级风险风控系统
    • 🟢 Low (Safe):只读/查询类操作(如 ls, netstat)。
    • 🟡 Medium (Caution):修改配置或文件系统(如 mkdir, chmod)。
    • 🔴 High (Dangerous):不可逆操作(如 rm -rf, mkfs),提供醒目的红色警示卡片。
  • 📚 RAG 知识库增强
    • 内置 tldr-pages 命令行文档库。
    • 通过 ChromaDB 向量检索,将权威文档作为上下文提供给大模型,显著减少幻觉。
    • 支持 多语言 Embedding,实现中英文混合检索。
  • 🌐 国际化 (I18n):支持 简体中文English 一键切换,界面文本与 AI 回复语言同步变更。
  • 🎨 现代化 UI
    • 基于 Tailwind CSS 的极简 Dashboard 设计。
    • 支持 BASH 代码高亮、一键复制。
    • 智能快捷指令推荐。

🛠️ 技术栈 (Tech Stack)

模块 技术选型 说明
Frontend HTML5, Tailwind CSS 无构建工具,轻量级单页应用
Logic Vanilla JS, Marked.js 前端逻辑与 Markdown 渲染
Backend Python 3, FastAPI 高性能异步 API 服务
LLM Volcengine (Doubao) 核心语义理解与代码生成
RAG ChromaDB, Sentence-Transformers 向量存储与检索
Data tldr-pages 权威命令行知识库 (已内置)

🚀 快速开始 (Quick Start)

1. 环境准备

确保已安装 Python 3.8+。

2. 下载/克隆项目

进入项目根目录:

cd linux-command-expert

3. 安装依赖

pip install -r backend/requirements.txt

(注意:首次运行会自动下载 Embedding 模型,约 400MB,请保持网络畅通)

4. 配置 API Key

backend 目录下创建 .env 文件,填入你的火山引擎密钥:

# backend/.env
ARK_API_KEY=你的火山引擎API_Key
ARK_MODEL_ID=你的豆包模型Endpoint_ID

5. 启动应用

在项目根目录下运行启动脚本:

python start.py
  • 终端将显示服务启动日志。
  • 默认浏览器会自动打开 http://localhost:8000,即可开始使用。

📂 项目结构

linux-helper/
├── start.py                # 项目启动入口 (自动启动后端+打开浏览器)
├── backend/
│   ├── main.py             # FastAPI 主服务 (Prompt工程, 路由, 风险判定)
│   ├── rag_engine.py       # RAG 核心 (ChromaDB 索引构建与检索逻辑)
│   ├── requirements.txt    # Python 依赖库
│   ├── .env                # 环境变量配置
│   └── data/               # 知识库数据存储目录 (内置 tldr 文档)
└── frontend/
    └── index.html          # 前端主界面 (HTML/CSS/JS 一体化)

⚠️ 免责声明 (Disclaimer)

本工具生成的命令基于大语言模型,虽经 RAG 增强,但仍可能存在偏差。 在生产环境中执行高风险命令(High Risk)前,请务必进行人工核对。 开发者不对因误操作导致的数据丢失或系统损坏负责。


📄 License

MIT License

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published