summaryrefslogtreecommitdiff
path: root/plugins/hanami/README.md
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2018-04-25 15:36:48 -0600
committerTuowen Zhao <ztuowen@gmail.com>2018-04-25 15:36:48 -0600
commit1481f7aa67df42bdf45953231637194ac200d240 (patch)
tree7d41eb6b369e3ab0f25753623c966b69340e54cf /plugins/hanami/README.md
parentb7b623d6de696b81d213ec666d072851561d5c06 (diff)
parent9cd3701ac0297f4bdf9673ea0dffa8ffdaea63e8 (diff)
downloadzsh-1481f7aa67df42bdf45953231637194ac200d240.tar.gz
zsh-1481f7aa67df42bdf45953231637194ac200d240.tar.bz2
zsh-1481f7aa67df42bdf45953231637194ac200d240.zip
Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh
Diffstat (limited to 'plugins/hanami/README.md')
-rw-r--r--plugins/hanami/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/plugins/hanami/README.md b/plugins/hanami/README.md
new file mode 100644
index 000000000..ef3451faf
--- /dev/null
+++ b/plugins/hanami/README.md
@@ -0,0 +1,32 @@
+# Hanami Plugin #
+This plugin adds convenient ways to work with [Hanami](http://hanamirb.org/) via console.
+It's inspired by Rails plugin, so if you've used it, you'll feel like home.
+
+## 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](http://hanamirb.org/guides/command-line/applications/).
+
+## 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 &#124; grep | Grep hanami routes with specified pattern |