Skip to content

zsh plugin to provide completions and aliases for the edward (micro-service/command launcher) CLI tool

License

Notifications You must be signed in to change notification settings

matthieusb/zsh-edward

Repository files navigation

Edward Zsh plugin

This edward plugin aims at making edward usage easier with completion scripts and aliases

zsh-edward usage gif

Installation

zsh-edward is not bundled with ZSH, so you need to install it.

This plugin can be installed by adding antigen bundle matthieusb/zsh-edward to your .zshrc file. Antigen will handle cloning the plugin for you automatically the next time you start zsh. You can also add the plugin to a running ZSH session with antigen bundle matthieusb/zsh-edward for testing before adding it to your .zshrc.

This plugin can be installed by adding zgen load matthieusb/zsh-edward to your .zshrc file in the same function you're doing your other zgen load calls in. Zgen will automatically clone the repositories for you when you do a zgen save.

Go to your oh-my-zsh folder and then in custom/plugins and clone this repository:

git clone https://github.com/matthieusb/zsh-edward.git

And then, add to to your .zshrc plugin list like this:

plugins=(... zsh-edward)

Dependencies

  • awk
  • sed
  • egrep
  • grep

Usage

This plugin solely contains completion scripts and aliases. It will allow you to have completion when starting/restarting/stopping services or groups.

Usage help

Edward can be used as usual:

Usage:
  edward [command]

Available Commands:
  generate    Automatically generate Edward config for a source tree
  help        Help about any command
  list        List available services and groups
  restart     Rebuild and relaunch a service or a group
  start       Build and launch a service or a group
  status      Display service status
  stop        Stop a service or a group
  tail        Tail the log for a service
  tiplog      View the tip (last 5 lines) of multiple, or all services
  version     Displays the currently installed version of Edward

Flags:
  -b, --backend stringSlice   Choose a specific backend for a service or group, of the form '<service>:<backend name>'
  -c, --config PATH           Use service configuration file at PATH
  -h, --help                  help for edward

Use "edward [command] --help" for more information about a command.

Some aliases are available through this plugin, completion still works when using them:

Alias Command
edgen edward generate
edh edward help
edlist edward list
edrestart edward restart
edstart edward start
edstatus edward status
edstop edward stop
edtail edward tail
edtiplog edward tiplog
edv edward version

About

zsh plugin to provide completions and aliases for the edward (micro-service/command launcher) CLI tool

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages