lucky_cli

1.5.091 versions

github.com/luckyframework/lucky_cli

A Crystal command-line tool for generating new Lucky Web Applications.

92 stars

8 dependents

License: MIT

Installation

# Add this to your shard.yml
dependencies:
  lucky_cli:
    github: luckyframework/lucky_cli
    version: ~> 1.5.0

Then run:

shards install

shard.yml

Crystal

~> 1.16

License

MIT

Author

Paul Smith

Target

lucky from src/lucky.cr

Dependencies

Runtime Dependencies

nox~> 0.2.3github: crystal-loot/nox
lucky_task~> 0.3.0github: luckyframework/lucky_task
lucky_template~> 0.2.0github: luckyframework/lucky_template

README

Lucky CLI

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 https://github.com/luckyframework/lucky

Installing the CLI

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

Development

Building the CLI

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

Install Crystal first.
Clone the repo git clone https://github.com/luckyframework/lucky_cli
Go to the repo directory cd lucky_cli
Install dependencies shards install
Run crystal build -o /usr/local/bin/lucky src/lucky.cr (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

Contributing

Fork it ( https://github.com/luckyframework/lucky_cli/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Install Earthly
Update fixtures with earthly +update-snapshot
Push to the branch (git push origin my-new-feature)
Check that specs on GitHub Actions CI pass earthly +gh-action-e2e
Create a new Pull Request

Contributors

paulcsmith Paul Smith - Original Creator of Lucky

Made with contrib.rocks.