dotfiles/zsh/.oh-my-zsh/plugins/hanami/README.md
2024-06-19 00:06:56 +02:00

2.6 KiB

Hanami Plugin

This plugin adds convenient aliases to work with Hanami via console. It's inspired by Rails plugin, so if you've used it, you'll feel like home.

To use it, add hanami to the plugins array in your zshrc file:

plugins=(... hanami)

Usage

For example, type hc into your console when you're within Hanami project directory to run the application console. Have a look at available shortcuts below. You can read more about these commands on the official website.

Aliases

Alias Command Description
HED* HANAMI_ENV=development Set environment variable HANAMI_ENV to development
HEP* HANAMI_ENV=production Set environment variable HANAMI_ENV to production
HET* HANAMI_ENV=test Set environment variable HANAMI_ENV to test
hc hanami console Run application console
hd hanami destroy Remove specified hanami resource
hg hanami generate Create specified hanami resource
hgm hanami generate migration Create migration file
hs hanami server Launch server with hanami application
hsp hanami server -p Launch server with specified port
hr hanami routes List application routes
hdc hanami db create Create application database
hdd hanami db drop Delete application database
hdp hanami db prepare Prepare database for the current environment
hda hanami db apply Recreates a fresh schema after migrations (destructive)
hdv hanami db version Print current database version
hdrs hdd && hdp Drop and recreate application database
hdtp HET hdp Actualize test environment database
hrg `hr grep`

* You should use these at the beginning of a command, for example:

$ HED hdd # equivalent to 'HANAMI_ENV=development hanami db drop'