📚 Read the Full Documentation Website: blackstart-labs.github.io/aliaskit/docs/MANUAL
A comprehensive, modular open-source Bash alias toolkit designed for all Linux environments. Whether you are a developer, operations engineer, or casual Linux user, Aliaskit supercharges your terminal with a beautiful UI.
- Modules: Break down aliases into logical domains (Git, Docker, Network, System, etc.)
- Built-in Docs: Auto-generate beautiful
--helpformatting directly from snippet comments. - Auto Updater: Hooks into
sudo apt updateto suggest Aliaskit tool upgrades smoothly! - Stats: Real-time GitHub community integration.
Linux / macOS / WSL (Windows):
curl -sL https://raw.githubusercontent.com/blackstart-labs/aliaskit/main/install.sh | bashThe installer auto-detects your OS and injects into the correct shell profile:
| Platform | Shell Profile | APT Hook |
|---|---|---|
| Ubuntu / Debian | ~/.bashrc |
✅ Optional |
| Arch / Fedora / Other Linux | ~/.bashrc |
❌ Skipped |
| macOS (Zsh) | ~/.zprofile |
❌ N/A |
| WSL / Git Bash | ~/.bashrc |
✅ Optional |
| To remove all scripts, configs, and APT background hooks: |
bash ~/.aliaskit/uninstall.shPlease see the Comprehensive Manual for detailed instructions on adding new # @desc modules and utilizing the shellcheck CI pipeline!
Once installed, reload your terminal or run source ~/.bashrc.
The central command is ak.
ak help-> Open interactive module explorer (fzf) with live preview.ak help git-> Show all commands available in the Git module.ak search logs-> Search for the word 'logs' across all descriptions and commands.ak stats-> Check out how many stars and forks the project has!ak update-> Update Aliaskit manually.ak add-> Launch custom module wizard (module + commands + desc/usage/example).ak edit-> Edit/delete your custom modules and commands.ak custom-> Show custom module statuses (including official conflicts).
Aliaskit generates a .aliaskit.conf file in your home directory. Open it to toggle individual modules on or off:
AK_ENABLE_DOCKER=true
AK_ENABLE_GIT=false # disable git aliasesStar us on GitHub and use ak stats to see where we're at!