Files
opencode/README.md

51 lines
2.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# OpenCode
基于交互式 CLI 智能体的开发辅助系统。
## 核心特性
- **工作流驱动**通过结构化的技能文档Skills指导 AI 执行复杂任务。
- **项目规范集成**针对不同语言Go, Android, iOS 等)提供最佳实践指南。
- **Git 自动化**:一键完成分析、提交、版本管理与推送。
- **Gitea 集成**:完整的仓库管理与 Actions Runner 运维能力。
## 目录结构
```
opencode/
├── skill/ # 结构化技能库与工作流说明
│ ├── git/ # Git 工作流 (Commit, Push, Tags)
│ ├── gitea/ # Gitea 平台集成与 Runner 管理
│ ├── android/ # Android 开发规范
│ ├── ios/ # iOS 开发规范
│ ├── go/ # Go 后端开发规范
│ ├── electron/ # Electron 桌面开发规范
│ ├── agent-browser/ # 浏览器自动化技能
│ ├── emqx/ # MQTT/EMQX 运维指南
│ └── opencode/ # 平台自身维护 (Command/Skill 创建)
├── AGENTS.md # 全局通用规则与提示词约束
├── opencode.json # 项目配置文件
├── package.json # 依赖与元数据
└── LICENSE # MIT 许可证
```
## 如何使用技能 (Skills)
在与 OpenCode 对话时,可以通过 `@skill` 语法直接引用对应的工作流:
- **Git 推送**`@skill/git/push-workflow.md 执行`
- **创建 Gitea Runner**`@skill/gitea/create-runner.md 帮我创建一个名为 my-runner 的 runner`
- **遵循项目规范**`@skill/go/SKILL.md 帮我重构这个 API 接口`
## 开发规范
本项目严格遵循 [AGENTS.md](./AGENTS.md) 中定义的全局规则:
- 必须使用**中文**进行交互。
- 严禁未经授权的自动 Git 提交操作(除非用户明确要求)。
- 优先保持回复简洁高效,减少 Token 消耗。
## 仓库地址
[https://git.shigongcao.com/ai/opencode.git](https://git.shigongcao.com/ai/opencode.git)