miaou-bash/README.md

MIAOU-BASH
===========

MIAOU-BASH is a collection of settings and helpers for leveraging BASH.
Developer-friendly, it may be used as solo package with or without the miaou project.

## Featuring

* [x] some aliases (l, ll, ltr, ...)
* [x] a smart prompt
  * [x] git, lxd, failure aware
* [x] simple vim and micro settings
* [x] Debian and Archlinux support

It's Free Software (AGPLv3), help yourself.
Any feedback would be appreciated. [contact@artcode.re](mailto:contact@artcode.re)

## install
`curl https://git.artcode.re/miaou/miaou-bash/raw/branch/main/install.sh | sudo bash -s`

## upgrade
`upgrade-miaou-bash`

## uninstall
`cd /opt/miaou-bash && sudo ./uninstall.sh`

## development mode (credentials required)
 
* REAL_DIR=/opt/miaou-bash
* sudo mkdir -m 755 $REAL_DIR && sudo chown $(id -un) $REAL_DIR
* git clone git@artcode.re:miaou/miaou-bash.git $REAL_DIR
* DEV_DIR=$HOME/DEV/BASH/miaou-bash # change DEST according to your needs!
* ln -s $REAL_DIR $DEV_DIR
* cd $REAL_DIR && sudo ./install.sh

## useful library 

* source /opt/miaou-bash/lib/functions.sh

## bindkeys

### by default

* CTRL + C => stop program
* CTRL + V => display bindkey
* CTRL + Z => interrupt for background job (fg, bg)

* SHIFT + CTRL + C => copy
* SHIFT + CTRL + V => paste

### customized

* CTRL LEFT, RIGHT => move between words
* CTRL DELETE, BACKSPACE => delete word
* ALT DELETE, BACKSPACE => delete line from cursor
* CTRL + SHIFT + / => undo