Library for creating and running tasks and generating Lucky projects lucky-framework command-line
1.2.0 Latest release released
89 48 42

Lucky CLI

Lucky CLI Main CI Lucky CLI Weekly CI

This is the CLI utility used for generating new Lucky Framework Web applications.

If you're looking for the Lucky core shard, you'll find that at

Installing the CLI

To install the Lucky CLI, read Installing Lucky guides for your Operating System.


Building the CLI

NOTE: this should be used for working on the CLI and submitting PRs.

  1. Install Crystal first.
  2. Clone the repo git clone
  3. Go to the repo directory cd lucky_cli
  4. Install dependencies shards install
  5. Run crystal build -o /usr/local/bin/lucky src/ (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


  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 GitHub Actions CI pass
  6. Create a new Pull Request


  github: luckyframework/cli
  version: ~> 1.2.0
License MIT
Crystal ~> 1.10


Dependencies 3

  • lucky_task ~> 0.3.0
    {'github' => 'luckyframework/lucky_task', 'version' => '~> 0.3.0'}
  • lucky_template ~> 0.2.0
    {'github' => 'luckyframework/lucky_template', 'version' => '~> 0.2.0'}
  • nox~crystal-loot ~> 0.2.3
    {'github' => 'crystal-loot/nox', 'version' => '~> 0.2.3'}

Development Dependencies 0

Dependents 0

Last synced .
search fire star recently