A Crystal library for creating and running tasks
paulcsmith Update templates for new lucky cookies (#259)

Cookie/Session accessing with .get and .get?
Cookie/Session setting with .set
Cookie removal with .expire
Session key removal with .unset
Flash.danger -> failure
Updating the FlashHandler
Updating the habitat settings for a new Lucky app including
Lucky::SessionCookie.key and Lucky::CookieJar.default_expiration
Removing old habitat settings (Lucky::Session::Store)
Latest commit ab20084 Oct 21, 2018



A Crystal library for creating and running tasks

Installing the CLI

  1. Install homebrew
  2. Run brew tap luckyframework/lucky
  3. 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}

Using LuckyCli in a non-Lucky web app

Add this to your application's shard.yml:

    github: luckyframework/lucky_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

Creating tasks

In tasks.cr

class App::SendDailyNotifications < LuckyCli::Task
  # What this task does
  banner "Send notifications to users"

  # Name is inferred from class name ("app.send_daily_notifications")
  # It can be overriden if desired:
  #    name "app.send_daily_notifications"

  def call
    # Code that sends notifications to all your users
    puts "Sent daily notifications!"

# 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 unless explicitly set with name.

You can see all available tasks by running lucky --help


  1. Fork it ( https://github.com/luckyframework/lucky_cli/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. [Install the required dependencies](https://luckyframework.org/guides/installing.html#install-required-dependencies
  4. Make sure specs pass: crystal spec
  5. To specs that deploy a sample app to Heroku, run RUN_HEROKU_SPECS=1 crystal spec. Make sure you've setup Heroku CLI locally first.
  6. Commit your changes (git commit -am 'Add some feature')
  7. Push to the branch (git push origin my-new-feature)
  8. Create a new Pull Request