Files
miaou-bash/README.md
T
2026-08-18 21:48:03 +04:00

65 lines
2.0 KiB
Markdown

# MIAOU-BASH
**MIAOU-BASH** is a collection of scripts and configurations designed to enhance your terminal experience. As the name suggests, it is built on Bash and is designed to work on most modern GNU/Linux systems.
Currently, the automated installation process supports two major distribution families:
* **Debian-based:** Debian, Ubuntu, Linux Mint, etc.
* **Arch-based:** Arch Linux, Manjaro, etc.
> **A quick note on naming:**
> * **MIAOU-BASH** (uppercase) refers to the entire project and package.
> * `miaou-bash` (lowercase) refers specifically to the core utility script included within the project.
For the absolute best experience, we highly recommend using the Ghostty terminal emulator.
## License & Feedback
This project is free and open-source software, licensed under the **GNU Affero General Public License v3.0 (AGPL-3.0)**.
We would love to hear your thoughts! Any feedback, suggestions, or contributions are greatly appreciated.
[contact@artcode.re](mailto:contact@artcode.re)
## install
<!-- markdownlint-disable MD013 MD025 -->
`source <(curl -s https://git.artcode.re/miaou/miaou-bash/raw/branch/main/install.sh)`
## upgrade
`miaou-bash --self-upgrade`
## uninstall
`miaou-bash --uninstall && exec bash -l`
## Readline main bindings
```bash
# CTRL + { left, right } for moving around words
# ALT + { left, right } for moving around Big:Words (faster)
# CTRL + { backspace, delete } for word suppressing
# ALT + { backspace, delete } for suppressing until start/end (faster)
# SHIFT + { backspace, delete } for suppressing the whole line
# { CTRL, ALT } + u for undo
# { up, down } for history search
```
## Featuring
* [x] default settings
* [x] inputrc
* [x] bashrc
* [x] some aliases (l, ll, ltr, ...)
* [x] smart prompt
* [x] git, failure aware
* [x] vimrc
* [x] ghostty
* [x] terminfo
* [x] global config
* [x] miaou-bash
* [x] friendly error message
* [x] stacktrace
* [x] tools
* [x] semver-git_tag
* [x] fqdn
* [ ] ...