Shellm is some kind of Bash framework for a personal use. It provides useful commands to help you write and manage your shell scripts. See the Quickstart section below to get an idea of what Shellm can do for you!

Installation

Installation is done by cloning the repo and sourcing the code from .bashrc (or another file sourced at terminal startup):

git clone https://github.com/Pawamoy/shellm.git ~/.shellm
echo '. ~/.shellm/init.sh' >> ~/.bashrc

Dependencies

• shellman: [sudo -H] pip install shellman

To run the test suite, also install these:

• bats:

  curl -Lo- "https://raw.githubusercontent.com/bpkg/bpkg/master/setup.sh" | sudo bash
  sudo bpkg install -g sstephenson/bats

• shellcheck:

  sudo curl -Lso /usr/bin/shellcheck https://github.com/caarlos0/shellcheck-docker/releases/download/v0.4.6/shellcheck
  sudo chmod +x /usr/bin/shellcheck

• checkbashisms (optional) and pcregrep:

  sudo apt-get install devscripts pcregrep

Quickstart

Shellm is basically a set of functions and command-line scripts. It lets you manage all your shell scripts and shell libraries within a single directory, allowing you to easily synchronize your shell environment and configuration across your different machines or servers (i.e. with CVS).

The main benefits from using Shellm are:

• just two lines appended in .bashrc, and you can put all the rest into your shellm user configuration
• fast creation and edition of scripts
• a C-like library inclusion system
• automatic help options and automatic man pages generation thanks to Shellman documentation
• already some shell libraries available (need your feedback!)
• already working test suite

Here are some instructions to get started:

# load shellm
. ~/.shellm/init.sh

# create a new empty project
shellm init my_project

# load the project configuration
shellm load my_project/profile

# create and open a new script in my_project/bin
shellm new my-script

# ... write the script

# execute it!
my-script --with=some arguments

# run it in debug
shellm debug my-script --with=other args

# run the test suite on your scripts
shellm test

# rename your script
shellm mv bin/my-script bin/not-working-script

# delete it
shellm rm bin/not-working-script

Documentation

Documentation can be found on the GitHub wiki!