msu

A minimal Bash framework and CLI tool that makes writing, sharing and using bash scripts easy

• Features
• Installation
• Documentation
• Showcase of modules using msu
• Project principles
• License
• Introductory blog posts:
  • hack with msu
  • very first post

features

msu wishlist

• easy installation
• self upgrade
• small internal library
• tested
• supports external modules
• auto-loading aliases from modules
• manpages
• load/unload aliases
• error catching/handling
• bash completion
• compatibility for other shell types e.g. zsh

installation

There are different ways of installing msu.

1. The preferred way is to use the OFFICIAL RELEASE. Download the latest tarball at https://github.com/GochoMugo/msu/releases/latest:

   $ tar xvf msu-x.x.x.tar.gz
   $ cd msu-x.x.x/
   $ ./install.sh

2. Manual installing by cloning this repo and running the install.sh script.

   $ git clone https://github.com/GochoMugo/msu.git
   $ cd msu/
   $ ./install.sh

   This method is preferable if you will be contributing to the project. Note that this uses the master branch, possibly with unreleased changes. Also, the manpages are not installed.

See further installation instructions.

documentation

You can browse msu documentation from your terminal using man:

$ man 1 msu       # command
$ man 3 msu       # library

A guide for contributing to msu is also available.

project principles

1. Little added complexity. msu should not warrant the user to learn scripting all over again. An existing script should be converted into a module with less effort.
2. Minimal. msu core should be as little as possible. How? Use common algorithms and data structures. Avoid doing something too fancy.
3. Highly configurable. Using environment variables and command-line switches, msu should be configurable in all its operations, including installation.

license

The MIT License (MIT)

Copyright © 2015 GochoMugo mugo@forfuture.co.ke