shell-utils

Introduction

This project is intend to serve you a bunch of convenient stuff include alias, functions, etc., which makes life easier.

Install

automatic

Open terminal and type:

curl -L https://github.com/oxnz/shell-utils/install.sh | sh

or

wget https://github.com/oxnz/shell-utils/install.sh -O - | sh

and this will append the source command in your .bashrc and .zshrc, then create the .shell directory under your $HOME.

manual

1. Clone the repository:

   git clone https://github.com/oxnz/shell-utils.git ~/.shell

2. Source bootstrap file in the dot-shrc file:

   echo '. ~/.shell/bootstrap.sh' >> ~/.bashrc echo '. ~/.shell/bootstrap.sh' >> ~/.zshrc

3. Already done, just open a new terminal and testing the amazing stuff.

Customize

If you want to override any of the default behaviors, just add the stuff in the custom/ directory.

Update

There's two strategies for update:

• manually:

  skel update

• automatically:

  skel set autoupdate=true

If you don't want check upgrade automatically:

skel set autoupdate=false

Uninstall

skel destroy

Infrastructure

~/.shell |___ rc/ # source entry directory, this directory is generated |___ skel/ # shell-utils manager |___ doc/ # documentation |___ bin/ # this path will add to the PATH variable |___ src/ # source code for libs and plugins |___ lib/ # library stuff used by plugin manager and dependencies |___ opt/ # plugins would be here |___ var/ # data files |___ core/ # source this directory unconditionally |___ ext/ # extension utils |___ tool/ # tools used for generate docs, check codes, etc. |___ test/ # test suits |___ custom/ # customize script |___ .git/ # git directory |___ .gitignore # ignore the .git and custom directory

For more details, please see doc/infrastructure

Notes

This section is intend leave blank

Contribute

If you have ideas on how to make the configuration easier to maintain (and faster), don’t hesitate to fork and send pull requests!

Any impovement is welcome

Guide lines:

1. the plugin manager should keep in one top directory
2. install script should be robust and most compatible
3. the startup should contain debug functionability such as list the loaded functions and libraries
4. should keep effeciency in mind, so compile needed
5. code should be documented, generate help file from source file
6. interface skel help func to system access, such as help in bash and run-help in zsh
7. cause there's many perl script in /bin and /usr/bin, so the skel implemented in perl, if needed, can be rewrite in C/C++

License

Shell-utils is distributed under the terms of the MIT license.

See LICENSE and COPYRIGHT for details