A Crystal library for creating and running tasks
- Install homebrew
- Run
brew tap luckyframework/lucky
- Run
brew install lucky
Run which lucky
from the command line to make sure it is installed.
If you're generating a Lucky web project, install the required dependencies. Then run lucky init {project_name}
Add this to your application's shard.yml
:
dependencies:
lucky_cli:
github: luckyframework/cli
Create a file tasks.cr
at the root of your project
require "lucky_cli"
# Using `lucky` from the command line will do nothing if you forget this
LuckyCli::Runner.run
In tasks.cr
class App::SendDailyNotifications < LuckyCli::Task
# What this task does
banner "Send notifications to users"
def call
# Code that sends notifications to all your users
puts "Sent daily notifications!"
end
end
# LuckyCli::Runner.run is below this
This will create a task that can be run with lucky app.send_daily_notifications
. The name is inferred from the name of the class.
You can see all available tasks by running lucky --help
- Fork it ( https://github.com/luckyframework/cli/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request
- paulcsmith Paul Smith - creator, maintainer