Lucky CLI

A Crystal library for creating and running tasks

Installing the CLI by Homebrew

  1. Install homebrew
  2. Run brew tap luckyframework/lucky
  3. Run brew install lucky

Building CLI from source

  1. Install crystal
  2. Clone the repo git clone
  3. Go to the repo directory cd lucky_cli
  4. Run shards install
  5. Run crystal build src/ -o /usr/local/bin/lucky
(instead of `/usr/local/bin/` destination you can choose any other directory that in `$PATH`)

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 at the root of your project

require "lucky_cli"

# Using `lucky` from the command line will do nothing if you forget this

Creating tasks


class App::SendDailyNotifications < LuckyCli::Task
  # What this task does
  summary "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!"

# 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


API (master)


  1. Fork it ( )
  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. Check that specs on Travis CI pass
  6. Create a new Pull Request

Testing Deployment to Heroku

Testing deployment to Heroku is skipped locally by default. The easiest way to run the deployment tests is to push up a branch and open a PR. This will run tests against Heroku to make sure deployment is working as expected.

If you want though, you can also test deployment locally:

  1. Sign up for a Heroku account and install the CLI.
  2. Run heroku authorizations:create --description="Lucky CLI Integration Tests".
  3. Grab the token from that command and put it in the generated .env file.
  4. Change RUN_HEROKU_SPECS from 0 to 1 in the .env file.
  5. Run script/setup to make sure all dependencies are installed.
  6. Run script/test to test everything, or run script/test specs/integration/