# cli
**Repository Path**: idcu/cli
## Basic Information
- **Project Name**: cli
- **Description**: IDCU CLI是由 IDCU (不羁盟) 组织开发的一站式全栈开发命令行工具集,旨在简化和标准化现代软件开发工作流。
无论您是单项目开发,还是多仓库/子模块项目管理,IDCU CLI 都能提供统一的命令接口,让您从繁琐的重复操作中解放出来,专注于创造价值。
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-03-21
- **Last Updated**: 2026-03-28
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# IDCU CLI - 不羁盟命令行工具
[](https://pypi.org/project/idcu-cli/)
[](https://www.python.org/downloads/)
[](LICENSE)
[](https://github.com/psf/black)
**🚀 一站式 DevOps 工具箱 - 让开发更高效,让部署更简单**
***
## ⚡ 5分钟快速开始
### 一键安装(推荐)
**Windows:**
```powershell
# 下载并运行安装脚本
Invoke-WebRequest -Uri "https://gitee.com/idcu/cli/raw/master/scripts/install-windows.ps1" -OutFile "install-windows.ps1"
.\install-windows.ps1
```
**Linux/Mac:**
```bash
# 下载并运行安装脚本
curl -fsSL https://gitee.com/idcu/cli/raw/master/scripts/install-linux.sh | bash
```
### 手动安装
```bash
# 1. 确保 Python 3.8+ 已安装
python --version
# 2. 安装 IDCU CLI
pip install idcu-cli
# 3. 验证安装
idcu --version
# 4. 启动交互式模式
idcu
```
### 你的第一个命令
```bash
# 列出当前目录下的所有 Git 仓库
idcu git list
# 查看所有 Git 仓库状态
idcu git status
# 构建 Maven 项目
idcu maven build
# 进入交互式模式(推荐新手使用)
idcu
```
***
## 🎯 为什么选择 IDCU CLI?
### ✨ 核心特色
| 特性 | 说明 |
|------|------|
| **多仓库管理** | 一次管理数十个仓库,批量操作省时间 |
| **跨语言支持** | Git、Maven、npm、Python、Go、Rust 全覆盖 |
| **AI 赋能** | 智能生成提交信息、代码审查、文档生成 |
| **插件系统** | 灵活扩展,自定义你的工作流 |
| **企业级安全** | 插件认证、审计日志、SSO 单点登录 |
### 📊 能力分层
#### 🟢 主航道 (Core/Stable) - 生产级稳定
- **Git 管理**:仓库扫描、状态查看、提交、推送、拉取、分支切换、子模块批量操作
- **Maven 构建**:项目发现、构建、依赖分析、Profile 管理、并行构建、梯队构建
- **质量检查**:编码检查/修复、依赖审计、TCK 测试
- **配置管理**:项目级配置、命令别名、配置热重载
- **插件系统**:插件发现、命令注册、示例插件
#### 🟡 增强 (Enhanced/Beta) - 持续完善
- **跨语言构建**:统一检测和构建 npm/yarn/pnpm、Python、Go、Rust 项目
- **团队协作**:团队配置初始化、导出、权限角色管理
- **发布管理**:发布分支、版本更新、构建部署流程
- **AI 能力**:OpenAI/Ollama 支持,提交信息生成、代码摘要、PR 摘要、代码审查
- 提示词模板管理:内置多种常用提示词模板(Conventional Commits、代码审查、代码生成等)
- 对话上下文管理:支持多轮对话和上下文保持
- 代码优化器:性能、内存优化和最佳实践建议
- **CI/CD 集成**:GitHub Actions、GitLab CI、Jenkins、Gitee Go 工作流生成
- 工作流验证:验证 CI/CD 工作流配置的正确性
- 管道指标收集:收集和分析 CI/CD 管道执行指标
- 部署管理:多环境部署配置和历史记录
- 通知管理:灵活的通知配置和发送
#### 🔴 企业版 (Enterprise) - 商业支持
- 插件认证(RSA 数字签名)
- 许可证管理和功能配额
- SSO 单点登录(OAuth2、SAML、LDAP)
- 审计日志和合规报告
- 日志聚合、性能监控、资源监控
- 移动端开发支持(iOS、Android、Flutter、React Native、鸿蒙)
#### 🧪 实验 (Experimental/Alpha) - 探索中
- **Web UI**:基于 FastAPI 的可视化 Web 界面
- **项目模板**:EST-SPI 标准模块模板生成
***
## 🚀 常用命令速查
### Git 工作流
```bash
# 列出所有 Git 仓库
idcu git list
# 查看所有仓库状态
idcu git status
# 批量提交
idcu git commit -m "feat: update module" -a
# 批量推送
idcu git push
# 批量拉取
idcu git pull
# 切换分支
idcu git switch develop
# 子模块状态
idcu git sub-status
# 同步子模块
idcu git sub-sync
```
### Maven 构建
```bash
# 列出所有 Maven 项目
idcu maven list
# 构建项目
idcu maven build
# 查看依赖树
idcu maven dep-tree
# 依赖分析
idcu maven dep-analyze
# 梯队列表
idcu maven tier-list
# 按梯队构建
idcu maven build-tier
# 并行构建
idcu maven parallel
```
### 质量检查
```bash
# 列出可用质量检查
idcu quality list
# 运行所有质量检查
idcu quality run
# 检查编码问题
idcu quality encoding check -p .
# 修复编码问题
idcu quality encoding fix -p . -t utf-8
# 依赖审计
idcu quality dependency-audit audit -p .
```
### AI 功能
```bash
# 生成提交信息
idcu ai commit
# 生成代码摘要
idcu ai summarize
# 代码审查
idcu ai review
# PR 分析
idcu ai pr-analyze
# 调试辅助
idcu ai debug
```
### 交互式模式
```bash
# 启动交互式菜单(推荐)
idcu
```
***
## 📦 安装可选功能
### 完整功能安装
```bash
# 安装所有可选功能
pip install "idcu-cli[interactive,web,ai,dev]"
```
### 按需安装
| 功能 | 安装命令 | 说明 |
|------|----------|------|
| 交互式模式 | `pip install "idcu-cli[interactive]"` | 交互式菜单、彩色输出 |
| Web UI | `pip install "idcu-cli[web]"` | FastAPI Web 界面 |
| AI 功能 | `pip install "idcu-cli[ai]"` | OpenAI/Ollama 集成 |
| 开发工具 | `pip install "idcu-cli[dev]"` | 测试、代码检查工具 |
### 从源码安装
```bash
git clone https://gitee.com/idcu/cli.git
cd cli
pip install -e ".[interactive,web,ai,dev]"
```
***
## ⚙️ 配置
### 配置文件位置
项目配置文件位于:`.idcu/config.yaml`
首次运行相关命令时会自动创建默认配置。
### 配置示例
```yaml
global:
color_output: true
verbose: false
quiet: false
dry_run: false
git:
default_branch: develop
remote_name: origin
auto_fetch: false
maven:
local_repo_path: .mvn/local-repo
default_goals:
- clean
- install
offline_mode: false
ai:
provider: openai
api_key: your-api-key
model: gpt-4
```
### 查看和修改配置
```bash
# 查看当前配置
idcu config show
# 重新加载配置
idcu config reload
```
***
## 🌐 国际化
IDCU CLI 支持多语言,默认根据系统语言自动选择。
```bash
# 查看可用语言
idcu language list
# 设置为中文
idcu language set zh
# 设置为英文
idcu language set en
# 查看当前语言
idcu language show
```
***
## 🔧 开发
### 运行测试
```bash
# 运行所有测试
pytest tests/ -v
# 运行单元测试
pytest tests/unit/ -v
# 运行 E2E 测试
pytest tests/e2e/ -v
```
### 静态代码检查
```bash
# 类型检查
mypy idcu/
# 代码格式化
ruff format
black .
# 代码 lint
ruff check
```
### 编码检查
```bash
# 检查所有文件编码
python scripts/check_encoding.py
```
***
## 📚 文档索引
| 文档 | 说明 |
|------|------|
| [快速上手指南](docs/user/cli.md) | 从安装到高级用法的完整教程 |
| [推荐工作流](docs/user/RECOMMENDED_WORKFLOWS.md) | 日常开发、多仓库管理、发布准备等实际场景 |
| [插件开发指南](docs/developer/plugin-development-guide.md) | 如何开发自定义插件 |
| [企业版文档](docs/enterprise/enterprise.md) | 企业级功能完整说明 |
| [CI/CD 指南](docs/user/ci-cd-guide.md) | CI/CD 集成和使用指南 |
| [Web UI 文档](docs/user/web.md) | Web 界面使用说明 |
| [FAQ](docs/user/FAQ.md) | 常见问题与排查建议 |
| [贡献指南](docs/contributor/CONTRIBUTING.md) | 如何为项目做贡献 |
| [发布流程](docs/releases/RELEASE.md) | 版本发布流程 |
***
## 🤝 社区与支持
- **项目主页**: https://gitee.com/idcu/cli
- **问题反馈**: https://gitee.com/idcu/cli/issues
- **在线文档**: https://gitee.com/idcu/cli#readme
### 加入社区
欢迎提交 Issue、Pull Request,或参与讨论!
***
## 📄 许可证
Apache License 2.0
***
IDCU CLI - 不羁盟命令行工具
统一命令入口,减少重复劳动,提升开发交付效率