📦 Dockyard CLI
Dockyard CLI 是一个基于 Go 语言开发的命令行工具,旨在简化和自动化项目的构建、部署和管理流程。
🔗 项目主页:immarktube.github.io/dockyard-cli
🚀 功能特性
- 模块化命令结构:通过
cmd/
目录组织命令,便于扩展和维护。 - 配置驱动:支持
.dockyard.yaml
配置文件,自定义构建和部署流程。 - 自动化执行:内置任务执行器,自动处理常见的构建和部署任务。
- 易于集成:可与现有的 CI/CD 流程无缝集成,提高开发效率。
🛠️ 安装与使用
安装
确保已安装 Go 环境(版本 1.16 及以上):
go install github.com/immarktube/dockyard-cli@latest
使用
- 在项目根目录创建
.dockyard.yaml
配置文件,定义构建和部署任务。 - 运行以下命令执行任务:
dockyard-cli command-name
详细的使用指南请参考:Dockyard CLI 使用指南
📁 项目结构
dockyard-cli/
├── cmd/ # 命令定义
├── command/ # 命令实现
├── config/ # 配置解析
├── docs/ # 文档
├── executor/ # 任务执行器
├── utils/ # 工具函数
├── .dockyard.yaml # 示例配置文件
├── .env # 示例配置文件
├── main.go # 主程序入口
└── build.sh # 构建脚本
📄 示例配置 .dockyard.yaml
global:
owner: immarktube
authToken: ${GITHUB_TOKEN}
apiBaseURL: https://api.github.com
concurrency: 5
repositories:
- path: ./repo_name1/
- path: ./repo_name2/
hook:
pre: echo "Running pre hook"
post: echo "Running post hook"
📄 Example .env
GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
🤝 贡献指南
欢迎贡献代码、提交问题或提出改进建议:
- Fork 本仓库。
- 创建新分支进行开发。
- 提交 Pull Request。
📄 许可证
本项目采用 MIT 许可证。详情请参阅 LICENSE 文件。