đĻ Dockyard CLI
Dockyard CLI is a command-line tool built in Go to simplify and automate project build, deployment, and task execution.
đ Project Homepage: immarktube.github.io/dockyard-cli
đ Features
- Modular Command Structure: Organized via the
cmd/
directory for easy extension and maintenance. - Configuration-Driven: Supports
.dockyard.yaml
for defining custom build and deployment pipelines. - Automated Task Execution: Built-in task runner for handling common project workflows.
- CI/CD Friendly: Easily integrates into your existing automation pipelines.
đ ī¸ Installation & Usage
Installation
Ensure you have Go (version 1.16 or later) installed:
go install github.com/immarktube/dockyard-cli@latest
Usage
- Create a
.dockyard.yaml
file at your project root to define tasks. - Run your tasks using:
dockyard command-name
For detailed usage instructions, visit: Dockyard CLI Documentation
đ Project Structure
dockyard-cli/
âââ cmd/ # Command definitions
âââ command/ # Command implementations
âââ config/ # Configuration parsing
âââ docs/ # Documentation
âââ executor/ # Task runner
âââ utils/ # Utility functions
âââ .dockyard.yaml # Example config file
âââ .env # Example config file
âââ main.go # Entry point
âââ build.sh # Build script
đ Example .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
đ¤ Contributing
We welcome contributions, issue reports, and suggestions!
- Fork this repository.
- Create a new feature branch.
- Submit a Pull Request.
đ License
This project is licensed under the MIT License. See the LICENSE file for details.