# Chris Titus Tech's Linux Utility [![Version](https://img.shields.io/github/v/release/ChrisTitusTech/linutil?color=%230567ff&label=Latest%20Release&style=for-the-badge)](https://github.com/ChrisTitusTech/linutil/releases/latest) ![GitHub Downloads (specific asset, all releases)](https://img.shields.io/github/downloads/ChrisTitusTech/linutil/linutil?label=Total%20Downloads&style=for-the-badge) [![](https://dcbadge.limes.pink/api/server/https://discord.gg/bujFYKAHSp)](https://discord.gg/bujFYKAHSp) [![Crates.io Version](https://img.shields.io/crates/v/linutil_tui?style=for-the-badge&color=%23af3a03)](https://crates.io/crates/linutil_tui) [![linutil AUR Version](https://img.shields.io/aur/version/linutil?style=for-the-badge&label=%5BAUR%5D%20linutil&color=%23230567ff)](https://aur.archlinux.org/packages/linutil) [![linutil-bin AUR Version](https://img.shields.io/aur/version/linutil-bin?style=for-the-badge&label=%5BAUR%5D%20linutil-bin&color=%23230567ff)](https://aur.archlinux.org/packages/linutil-bin) ![Preview](/.github/preview.gif) **Linutil** is a distro-agnostic toolbox designed to simplify everyday Linux tasks. It helps you set up applications and optimize your system for specific use cases. The utility is actively developed in Rust πŸ¦€, providing performance and reliability. > [!NOTE] > Since the project is still in active development, you may encounter some issues. Please consider [submitting feedback](https://github.com/ChrisTitusTech/linutil/issues) if you do. ## ⬇️ Installation Linutil is also available as a package in various repositories: [![Packaging status](https://repology.org/badge/vertical-allrepos/linutil.svg)](https://repology.org/project/linutil/versions)
Arch Linux Linutil can be installed on [Arch Linux](https://archlinux.org) with three different [AUR](https://aur.archlinux.org) packages: - `linutil` - Stable release compiled from source - `linutil-bin` - Stable release pre-compiled - `linutil-git` - Compiled from the last commit (not recommended) by running: ```bash git clone https://aur.archlinux.org/.git cd makepkg -si ``` Replace `` with your preferred package. If you use [yay](https://github.com/Jguer/yay), [paru](https://github.com/Morganamilo/paru) or any other [AUR Helper](https://wiki.archlinux.org/title/AUR_helpers), it's even simpler: ```bash paru -S linutil ``` Replace `paru` with your preferred helper and `linutil` with your preferred package.
OpenSUSE Linutil can be installed on OpenSUSE with: ```bash sudo zypper install linutil ```
Cargo Linutil can be installed via [Cargo](https://doc.rust-lang.org/cargo) with: ```bash cargo install linutil_tui ``` Note that crates installed using `cargo install` require manual updating with `cargo install --force` (update functionality is [included in LinUtil](https://christitustech.github.io/linutil/userguide/#applications-setup))
## πŸ’‘ Usage To get started, pick which branch you would like to use, then run the command in your terminal: ### Stable Branch (Recommended) ```bash curl -fsSL https://christitus.com/linux | sh ``` ### Dev branch ```bash curl -fsSL https://christitus.com/linuxdev | sh ``` ### CLI arguments Linutil supports various command-line arguments to customize its behavior. Here are some common arguments you can use: - `-c, --config ` : Path to the configuration file. - `--override-validation` : Show all available options, disregarding compatibility checks (UNSAFE). - `--size-bypass` : Bypass the terminal size limit. - `-y, --skip-confirmation` : Skip confirmation prompt before executing commands. - `-t, --theme ` : Set the theme to use in the application [default: `default`] [possible values: `default`, `compatible`]. - `-h, --help` : Print help. For more detailed usage, run: ```bash curl -fsSL https://christitus.com/linux | sh -s -- --help ``` ```bash linutil --help ``` ## Configuration Linutil supports configuration through a TOML config file. Path to the file can be specified with `--config` (or `-c`). Available options: - `auto_execute` - a list of commands to execute automatically (can be combined with `--skip-confirmation`) Example config: ```toml # example_config.toml auto_execute = [ "Fastfetch", "Alacritty", "Kitty" ] ``` ```bash linutil --config /path/to/example_config.toml ``` ## πŸ’– Support If you find Linutil helpful, please consider giving it a ⭐️ to show your support! ## πŸŽ“ Documentation For comprehensive information on how to use Linutil, visit the [Linutil Official Documentation](https://chris-titus-docs.github.io/linutil-docs/). ## πŸ›  Contributing We welcome contributions from the community! Before you start, please review our [Contributing Guidelines](.github/CONTRIBUTING.md) to understand how to make the most effective and efficient contributions. [Official LinUtil Roadmap](https://chris-titus-docs.github.io/linutil-docs/roadmap/) Docs are now [here](https://github.com/Chris-Titus-Docs/linutil-docs) ## πŸ… Thanks to All Contributors Thank you to everyone who has contributed to the development of Linutil. Your efforts are greatly appreciated, and you’re helping make this tool better for everyone! [![Contributors](https://contrib.rocks/image?repo=ChrisTitusTech/linutil)](https://github.com/ChrisTitusTech/linutil/graphs/contributors) ## πŸ“œ Contributor Milestones - 2024/07 - Original Linutil Rust TUI was developed by [@JustLinuxUser](https://github.com/JustLinuxUser). - 2024/09 - TabList (Left Column) and various Rust Core/TUI Improvements developed by [@lj3954](https://github.com/lj3954) - 2024/09 - Cargo Publish, AUR, Rust, and Bash additions done by [@adamperkowski](https://github.com/adamperkowski) - 2024/09 - Rust TUI Min/Max, MultiSelection, and Bash additions done by [@jeevithakannan2](https://github.com/jeevithakannan2) - 2024/09 - Various bash updates and standardization done by [@nnyyxxxx](https://github.com/nnyyxxxx) - 2024/09 - Multiple bash script additions done by [@guruswarupa](https://github.com/guruswarupa)