# Sheepdog

**Repository Path**: carlbase/Sheepdog

## Basic Information

- **Project Name**: Sheepdog
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-25
- **Last Updated**: 2026-09-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
  <img src="public/icon.png" alt="Sheepdog" width="128" height="128">
</p>

<h1 align="center">Sheepdog</h1>


# Sheepdog Agent — 你的 IT 运维 AI 搭档

[English](README.md) | [中文](README.zh-CN.md)

Sheepdog Agent 是一款专为 IT 运维打造的 AI 助手，它将人工智能与运维工具有机结合，帮助您高效完成服务器管理、故障诊断、集群部署等任务。

## 核心能力

### 🤖 AI 智能运维
- **智能诊断**：自动分析服务器状态，快速定位问题根源
- **命令生成**：根据自然语言描述自动生成运维命令
- **知识辅助**：提供最佳实践建议和操作指导
- **多会话管理**：支持并行处理多个运维任务

### 🖥️ 专业终端体验
- **多协议支持**：SSH、Telnet、Serial、Mosh 等连接方式
- **高级终端功能**：标签管理、分屏、搜索、复制粘贴
- **自动补全**：命令历史、路径补全、代码片段快速插入
- **主题定制**：丰富的主题和字体选项

### 📁 SFTP 文件管理
- **内置编辑器**：直接查看和编辑远程文件
- **拖拽传输**：便捷的文件上传下载
- **批量操作**：支持文件夹的递归传输

### 🔐 安全凭据管理
- **Vault 加密存储**：集中管理 SSH 密钥、密码、连接凭据
- **密钥管理**：支持生成、导入、导出 SSH 密钥
- **代理配置**：灵活的代理配置支持

### 🚀 效率工具集
- **端口转发**：图形化的本地/远程端口转发管理
- **脚本自动化**：记录和执行自动化脚本
- **系统监控**：Docker 容器/镜像管理、GPU 监控、进程管理、服务状态
- **会话恢复**：意外退出后可恢复工作状态

## 技术架构

```
┌─────────────────────────────────────────────────────┐
│                   前端 (React + Vite)                │
│  ┌─────────────┐  ┌─────────────┐  ┌─────────────┐ │
│  │  AI Chat    │  │  Terminal   │  │   Vault     │ │
│  │  Panel      │  │  Layer      │  │   View      │ │
│  └─────────────┘  └─────────────┘  └─────────────┘ │
│  ┌─────────────┐  ┌─────────────┐  ┌─────────────┐ │
│  │  SFTP       │  │  Settings   │  │  System     │ │
│  │  Panel      │  │  Page       │  │  Manager    │ │
│  └─────────────┘  └─────────────┘  └─────────────┘ │
└─────────────────────────────────────────────────────┘
                          │
┌─────────────────────────────────────────────────────┐
│              Tauri 2 后端 (Rust)                     │
│  ┌───────────┐  ┌───────────┐  ┌─────────────────┐ │
│  │  SSH      │  │  AI SDK    │  │  Plugin         │ │
│  │  Core     │  │  v7        │  │  Platform       │ │
│  └───────────┘  └───────────┘  └─────────────────┘ │
└─────────────────────────────────────────────────────┘
                          │
┌─────────────────────────────────────────────────────┐
│              Electron 主进程 (遗留)                  │
└─────────────────────────────────────────────────────┘
```

### 核心模块

| 模块 | 职责 |
|------|------|
| `application/` | 应用状态管理、事件处理、工作流协调 |
| `components/` | UI 组件（终端、AI 面板、Vault、SFTP 等） |
| `domain/` | 领域模型、类型定义、业务逻辑 |
| `docs/designs/` | 架构设计文档、协议规范 |
| `docs/research/` | 技术调研、竞品分析 |

## 快速开始

### 环境要求

- Node.js 20+
- Rust 1.70+
-pnpm

### 开发环境

```bash
# 克隆仓库
git clone https://gitee.com/carlbase/Sheepdog.git
cd Sheepdog

# 安装依赖
pnpm install

# 启动开发模式 (Vite + Electron)
pnpm dev
```

### 构建

```bash
# 生产构建
pnpm build

# 为当前平台打包
pnpm package

# 为特定平台打包
pnpm package -- --platform linux
pnpm package -- --platform macos
pnpm package -- --platform windows
```

## 项目结构

```
Sheepdog/
├── application/           # 主应用逻辑层
│   ├── state/            # 状态管理
│   ├── sftp/             # SFTP 传输模块
│   ├── useAI*.ts         # AI 相关 Hooks
│   └── ...               
├── components/           # React UI 组件
│   ├── ai/              # AI 面板组件
│   ├── terminal/        # 终端组件
│   ├── sftp/            # SFTP 组件
│   ├── vault/           # Vault 组件
│   └── settings/        # 设置页面
├── domain/              # 领域模型和类型
├── build/               # 构建资源
├── docs/                # 文档
│   ├── designs/        # 架构设计
│   ├── research/       # 技术调研
│   └── assets/         # 静态资源
└── locales/             # 国际化资源
```

## 功能演示

### AI 实战场景

```bash
# 诊断服务器问题
用户: "帮我看看这台服务器为什么这么卡"
AI: 自动执行诊断命令，分析 CPU、内存、磁盘 IO...
```

### 单主机智能诊断

```bash
# 连接并诊断
用户: "连接 192.168.1.100，检查系统资源使用情况"
AI: 自动连接，分析性能瓶颈，提供优化建议
```

### Docker Swarm 集群搭建

```bash
# 集群部署
用户: "帮我初始化一个 Docker Swarm 集群"
AI: 自动生成配置，完成初始化，验证集群状态
```

## 国际化

Sheepdog 支持多种语言：

- English (en)
- 简体中文 (zh-CN)
- 繁體中文 (zh-TW)
- Español (es)
- Русский (ru)

## 贡献指南

我们欢迎社区贡献！请阅读 [CONTRIBUTING.md](CONTRIBUTING.md) 了解详情。

### 报告问题

遇到问题时，请：

1. 确认问题可复现
2. 收集相关日志（设置 → 系统 → 崩溃日志）
3. 在 [Gitee Issues](https://gitee.com/carlbase/Sheepdog/issues) 报告

## 许可证

本项目采用 MIT 许可证，详见 [LICENSE](LICENSE) 文件。

## 隐私与安全

- 本地数据处理，敏感信息加密存储
- 详细的隐私政策请参阅 [PRIVACY.md](PRIVACY.md)
- 代码签名确保软件完整性，详见 [CODE_SIGNING_POLICY.md](CODE_SIGNING_POLICY.md)

## 获取帮助

- 📖 [官方文档](docs/)
- 🐛 [问题反馈](https://gitee.com/carlbase/Sheepdog/issues)
- 💬 [Gitee 讨论](https://gitee.com/carlbase/Sheepdog/discussions)

---

**Sheepdog Agent** — 让 AI 成为您最得力的运维搭档！


查看 [agents.md](agents.md) 了解架构概述和编码规范。