Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
67 lines (50 sloc) 3 KB
class Guides::GettingStarted::Installing < GuideAction
ANCHOR_INSTALL_REQUIRED_DEPENDENCIES = "perma-install-required-dependencies"
guide_route "/getting-started/installing"
def self.title
"Installing Lucky"
def markdown
## Install Required Dependencies
To get Lucky, you need to install these first.
* Install one of these process managers: [Overmind (recommended)](,
[Heroku CLI (great if you plan to use Heroku to deploy)](,
or [foreman](
* [Crystal v0.30](
* Postgres ([macOS]([Others](
### Debian and Fedora dependencies
* Debian (Ubuntu should be similar): run `apt-get install libc6-dev libevent-dev libpcre2-dev libpng-dev libssl1.0-dev libyaml-dev zlib1g-dev`
* Fedora (28): run `dnf install glibc-devel libevent-devel pcre2-devel openssl-devel libyaml-devel zlib-devel libpng-devel`. libpng-devel is for Laravel Mix
### For building assets (skip if building APIs)
* [Node]( Requires at least v6
* [Yarn](
## Install Lucky CLI
Once the required dependencies are installed, set up Lucky for your system.
### On macOS
* Install [Homebrew](
* Run `brew install openssl` to make sure you have OpenSSL
* Run `brew tap luckyframework/homebrew-lucky`
* Run `brew install lucky`
* Make sure [Postgres CLI tools](
are installed if you're using
* If you are on macOS High Sierra you need to add `export PKG_CONFIG_PATH=/usr/local/opt/openssl/lib/pkgconfig`
to your `~/.bash_profile` or `~/.zshrc`
> If you get an error like this: `Package libssl/libcrypto was not found in the
pkg-config search path` then be sure to run the last step listed above so that
Crystal knows where OpenSSL is located.
### On Linux
* `git clone` the CLI repo at
* cd into the newly cloned directory
* Check out latest [released version]( `git checkout #{LuckyCliVersion.current_tag}`
* Run `shards install`
* Run `crystal build src/`
* Move the generated `lucky` binary to your path. Most of the time you can move
it to `/usr/local/bin` and it should work: `mv lucky /usr/local/bin`.
If you needed different steps, please help contribute to this section by
[editing this page on GitHub](
You can’t perform that action at this time.