From c2499541e52131e2215fd32034af4baed9797263 Mon Sep 17 00:00:00 2001 From: "Y." Date: Wed, 12 Aug 2015 09:06:03 +0200 Subject: [PATCH] Docs on using the bash client in other shells --- docs/community/clients.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/community/clients.md b/docs/community/clients.md index 7b4d4ef3b..1b5f382f9 100644 --- a/docs/community/clients.md +++ b/docs/community/clients.md @@ -4,7 +4,7 @@ Given the constraints, running dokku commands remotely via SSH is fine. For cert While dokku does not yet have an official client, there are a multitude of ways in which you can interact with your dokku installation. The easiest is to use the **bash** client, though you may wish to use another. -## (bash) `dokku_client.sh` +## (bash, zsh, etc.) `dokku_client.sh` Of all methods, this is the *most* official method of interacting with your dokku installation. It is a bash script that interacts with a remote dokku installation via ssh. It is available in `contrib/dokku_client.sh` in the root of the dokku repository. @@ -18,6 +18,19 @@ git clone git@github.com:progrium/dokku.git ~/.dokku alias dokku='$HOME/.dokku/contrib/dokku_client.sh' ``` +Alternatively, if using another shell such as **zsh**, create an alias command which invokes the script using **bash**: + +```shell +# zsh: add the following to either .zshenv or .zshrc +alias dokku='bash $HOME/.dokku/contrib/dokku_client.sh' + +# fish: add the following to ~/.config/fish/config.fish +alias dokku 'bash $HOME/.dokku/contrib/dokku_client.sh' + +# csh: add the following to .cshrc +alias dokku 'bash $HOME/.dokku/contrib/dokku_client.sh' +``` + Configure the `DOKKU_HOST` environment variable or run `dokku` from a repository with a git remote named dokku pointed at your dokku host in order to use the script as normal. ## (nodejs) dokku-toolbelt