105 lines
5.8 KiB
Markdown
105 lines
5.8 KiB
Markdown
# OpenCode
|
||
|
||
OpenCode 是一个强大的交互式 CLI 工具，帮助开发者高效地完成软件工程任务。它提供智能化的命令、可复用的技能以及扩展插件，支持自动化工作流程。
|
||
|
||
## 📊 项目统计
|
||
|
||
- **15 个 CLI 命令** - 涵盖 Git 和 Gitea 操作
|
||
- **7 个开发领域技能库** - Android、iOS、Go、Electron、MQTT 等
|
||
- **4 套 CI/CD 工作流模板** - 适配多种项目类型
|
||
- **50+ 文档文件** - 完整的指南和参考资料
|
||
|
||
## 🌟 核心特性
|
||
|
||
- **智能命令系统** - 自动生成提交信息、管理版本标签、安全地暂存文件
|
||
- **可复用技能** - 预定义的开发工作流，如 Git 工作流、Android 开发等
|
||
- **插件扩展** - 支持自定义插件来扩展功能
|
||
- **安全优先** - 自动过滤敏感文件，防止意外泄露凭证
|
||
- **中文友好** - 完整的中文支持和交互提示
|
||
|
||
## 📋 完整目录结构
|
||
|
||
```
|
||
opencode/
|
||
├── command/ # CLI 命令定义
|
||
│ ├── git-add.md # 智能暂存文件（自动过滤敏感文件）
|
||
│ ├── git-commit.md # 自动生成提交信息并提交
|
||
│ ├── git-pull.md # 拉取远程最新变更
|
||
│ ├── git-push.md # 提交+创建标签+推送（一键完成）
|
||
│ ├── git-push-tags.md # 推送所有标签到远程
|
||
│ ├── git-status.md # 查看仓库状态
|
||
│ ├── gitea-config.md # 查看 Gitea 配置和 Runner 状态
|
||
│ ├── gitea-create-repo.md # 在 Gitea 创建新仓库
|
||
│ ├── gitea-create-runner.md # 创建并启动 Gitea Actions Runner
|
||
│ ├── gitea-delete-runner.md # 删除已配置的 Runner
|
||
│ ├── gitea-list-runners.md # 列出所有已配置的 Runners
|
||
│ ├── gitea-reset.md # 重置 Gitea 配置
|
||
│ ├── gitea-switch-org.md # 切换默认组织
|
||
│ └── review.md # 代码审查命令
|
||
│
|
||
├── skill/ # 可复用技能库和指南
|
||
│ ├── git/ # Git 工作流程和版本管理
|
||
│ │ ├── SKILL.md # 完整的 Git 工作流程指南
|
||
│ │ └── quick-reference.md # Git 快速参考
|
||
│ │
|
||
│ ├── gitea/ # Gitea 平台集成
|
||
│ │ ├── SKILL.md # Gitea 完整指南
|
||
│ │ ├── setup-guide.md # 初始化和配置指南
|
||
│ │ ├── repository-operations.md # 仓库操作指南
|
||
│ │ ├── runner-management.md # Runner 管理指南
|
||
│ │ ├── api-reference.md # Gitea API 参考
|
||
│ │ ├── troubleshooting.md # 常见问题和解决方案
|
||
│ │ ├── workflow-generator.md # Workflow 自动生成工具
|
||
│ │ └── workflow-templates/ # CI/CD Workflow 模板库
|
||
│ │ ├── android-app.md # Android App 构建 Workflow
|
||
│ │ ├── go-backend.md # Go 后端服务 Workflow
|
||
│ │ ├── nodejs-frontend.md # Node.js 前端 Workflow
|
||
│ │ └── wechat-miniprogram.md # 微信小程序 Workflow
|
||
│ │
|
||
│ ├── android-developer/ # Android 开发指南
|
||
│ │ └── SKILL.md # Android 项目开发规范
|
||
│ │
|
||
│ ├── ios-developer/ # iOS 开发指南
|
||
│ │ └── SKILL.md # iOS 项目开发规范
|
||
│ │
|
||
│ ├── go-developer/ # Go 后端开发指南
|
||
│ │ └── SKILL.md # Go 项目开发规范
|
||
│ │
|
||
│ ├── electron-developer/ # Electron 桌面应用指南
|
||
│ │ └── SKILL.md # Electron 项目开发规范
|
||
│ │
|
||
│ └── mqtts-developer/ # MQTT over TLS/SSL 开发指南
|
||
│ ├── SKILL.md # MQTT 完整指南
|
||
│ ├── README.md # MQTT 项目说明
|
||
│ ├── setup-mqtts-acme.md # ACME 证书配置
|
||
│ ├── mqtts-client-config.md # 客户端配置
|
||
│ ├── mqtts-quick-reference.md # 快速参考
|
||
│ └── USAGE_EXAMPLES.md # 使用示例
|
||
│
|
||
├── plugin/ # 插件扩展系统
|
||
│ └── notification.ts # 通知插件（邮件、Slack、钉钉等）
|
||
│
|
||
├── README.md # 项目说明文档（当前文件）
|
||
├── AGENTS.md # 全局开发规范和指南
|
||
├── opencode.json # 项目配置文件
|
||
├── package.json # Node.js 依赖配置
|
||
└── .gitignore # Git 忽略文件配置
|
||
```
|
||
|
||
### 目录说明
|
||
|
||
| 目录 | 用途 | 说明 |
|
||
|------|------|------|
|
||
| `command/` | CLI 命令 | 15 个内置命令，支持 Git、Gitea 等操作 |
|
||
| `skill/` | 开发指南 | 7 个开发领域的完整工作流程和最佳实践 |
|
||
| `skill/git/` | Git 工作流 | 提交规范、版本管理、Tag 规范等 |
|
||
| `skill/gitea/` | Gitea 集成 | 仓库、Runner、API、CI/CD Workflow 管理 |
|
||
| `skill/gitea/workflow-templates/` | 工作流模板 | 4 套预定义的 CI/CD Workflow 模板 |
|
||
| `skill/android-developer/` | Android 开发 | Kotlin、Jetpack Compose、MVVM 架构规范 |
|
||
| `skill/ios-developer/` | iOS 开发 | Swift、SwiftUI、iOS 26+ 最佳实践 |
|
||
| `skill/go-developer/` | Go 开发 | 后端开发规范、测试标准、质量工具 |
|
||
| `skill/electron-developer/` | Electron 开发 | TypeScript、Lit Web Components、跨平台实践 |
|
||
| `skill/mqtts-developer/` | MQTT 开发 | MQTT over TLS/SSL 协议、安全通信 |
|
||
| `plugin/` | 插件系统 | 扩展功能，支持自定义开发 |
|
||
|