maru2 (for now)
Important
Until this callout is removed, maru2 is in maintenance mode while other efforts take priority.
The current API is considered stable and any breaking changes will be done in a backwards compatible manner.
Dependency and security updates will still continue to be performed as needed.
Issues and Pull Requests are welcome, the CLI team may just take longer to respond.
A simple task runner.
Installation
via brew:
brew install defenseunicorns/tap/maru2
via curl:
curl -s https://raw.githubusercontent.com/defenseunicorns/maru2/main/install.sh | bashvia wget:
wget -q -O - https://raw.githubusercontent.com/defenseunicorns/maru2/main/install.sh | bashvia go install:
go install github.com/defenseunicorns/maru2/cmd/maru2@latest
or if you like to live dangerously:
go install github.com/defenseunicorns/maru2/cmd/maru2@main
or checkout the latest release artifacts.
Documentation
View CLI usage w/ maru2 --help
If you are coming from maru-runner / uds run and looking to transition, checkout the migration guide.
If you are looking to embed maru2 into another Cobra CLI, take a look at the example in cmd/internal.
If you are looking for Go docs, the best way to view them is go doc -http or visit pkg.go.dev.
Contributing
Thanks for taking time out of your day to contribute! Read the contributing guide for more information.
Schema Validation
Enabling schema validation in VSCode:
"yaml.schemas": { "https://raw.githubusercontent.com/defenseunicorns/maru2/main/maru2.schema.json": "tasks.yaml", },
Per file basis:
# yaml-language-server: $schema=https://raw.githubusercontent.com/defenseunicorns/maru2/main/maru2.schema.json