Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/axvm/cake
Cake is a powerful and flexible Make-like utility tool. Make Tasks Great Again!
https://github.com/axvm/cake
cake crystal rake ruby tasks
Last synced: about 1 month ago
JSON representation
Cake is a powerful and flexible Make-like utility tool. Make Tasks Great Again!
- Host: GitHub
- URL: https://github.com/axvm/cake
- Owner: axvm
- License: mit
- Created: 2017-05-13T16:01:06.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-07-09T18:04:17.000Z (over 2 years ago)
- Last Synced: 2024-08-01T17:36:33.678Z (4 months ago)
- Topics: cake, crystal, rake, ruby, tasks
- Language: Crystal
- Size: 28.3 KB
- Stars: 71
- Watchers: 5
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-crystal - cake - Production-ready Make-like utility tool (Task management)
- awesome-crystal - cake - Production-ready Make-like utility tool (Task management)
- awesome-crystal - cake - Production-ready Make-like utility tool (Task management)
README
# Cake [](https://travis-ci.org/axvm/cake)
Cake is a powerful and flexible Make-like utility tool.
Implement tasks on plain crystal-lang and Make Tasks Great Again!
## Installation
Execute command to install `Cake`
```shell
$ curl https://raw.githubusercontent.com/axvm/cake/master/install.sh | bash
```
## Usage
Develop tasks in plain Crystal code in `Cakefile` and run them via `$ cake :task_name`
### bin/cake
```
Usage:
cake task_name
cake -T
Options:
-T, --tasks Show all tasks
-h, --help This info
-v, --version Show version
```
### Cakefile sample
```Crystal
# Define task
task :task_name do
# task logic
end
# Define task with description
desc "task useful description"
task :some_task do
# 2 + 1
end
# Run one task from another
desc "invoke example"
task :first do
# -Infinity / 0
invoke! :second
end
task :second do
# yay we are here!
end
# Execute shell commands
task :build do
execute "shards build"
# or with sweet logs
execute(
cmd: "shards build",
announce: "Building binary...",
success: "Binary built!",
error: "Build failed."
)
end
# Log things
task :deploy do
# your deploy code
log "Deploy successful!"
log "Or errored.", 1
end
```
## Development
1. Implement feature and tests
2. Create pull request
3. ...
4. Profit!
## Contributing
1. Fork it ( https://github.com/axvm/cake/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
## Contributors
- [[axvm]](https://github.com/axvm) Alexander Marchenko - creator, maintainer
- [[alexandregv]](https://github.com/alexandregv) Alexandre Guiot--Valentin - contributor