Skip to content
Like git, but misspelled
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
README.md
gut-cert.sh
gut-color.sh
gut-column.sh
gut-env.sh
gut-git.sh
gut-kv.sh
gut-menu.sh
gut-time.sh
gut-update.sh
gut.sh
install-dev.sh
install.sh
release.sh

README.md

gut

Collection of plugins that simplifies development workflow

Core Plugins:

Dependencies:

  • awk
  • base64
  • cat
  • curl
  • date
  • echo
  • git
  • grep
  • openssl
  • read
  • sed
  • tr
  • wc

Install

$ curl -sSL https://github.com/jareddlc/gut/raw/master/install.sh | sh

This will create the env $GUT_HOME which defaults to $HOME/.gut

Usage

Gut has autocomplete support

$ gut -h

Plugins

Gut has a simple "plugin" support in which it will attempt to read files placed in the $GUT_HOME directory and look for the following lines:

  • GUT_EXPORT_FUNCTIONS - exact name of the function as written in the plugin
  • GUT_EXPORT_NAMES - name that will appear in the gut help menu
  • GUT_EXPORT_DESCRIPTIONS - description that will appear in the gut help menu

Here is an example of the "update plugin"

GUT_EXPORT_FUNCTIONS=("_gut_update")
GUT_EXPORT_NAMES=("update")
GUT_EXPORT_DESCRIPTIONS=("Updates gut")

Contributing

Want to contribute to the project? Follow the style guide for submiting pull requests.

Style guide

  • Functions names are written in snake_case and must start with filename: myfile_myfunction() {...}
  • Strings are enclosed with braces: ${my_string}
  • Variables are written in 'snake_case'
  • Variable assignments via functions are called using subshells: local encoded_key=$(echo "${key}" | base64)
  • Local variable names are written in lowercase
  • Global variable names are written in uppercase
  • Comments start with uppercase

Docs

# Function summary
# @param {type} name - Description
function_name() {...}
You can’t perform that action at this time.