search

ChrisTitusTech / linutil

Chris Titus Tech's Linux Toolbox - Linutil is a distro-agnostic toolbox designed to simplify everyday Linux tasks.
https://christitus.com
MIT License
2.81k stars 227 forks source link
linux

readme

Chris Titus Tech's Linux Utility

Version GitHub Downloads (specific asset, all releases)

Crates.io Version linutil AUR Version linutil-bin AUR Version

Preview

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 if you do.

💡 Usage

To get started, pick which branch you would like to use, then run the command in your terminal:

Stable Branch (Recommended)

curl -fsSL https://christitus.com/linux | sh

Dev branch

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:

For more detailed usage, run:

curl -fsSL https://christitus.com/linux | sh -s -- --help
linutil --help

⬇️ Installation

Linutil is also available as a package in various repositories:

Packaging status

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 ``` 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))

Configuration

Linutil supports configuration through a TOML config file. Path to the file can be specified with --config (or -c).

Available options:

Example config:

# example_config.toml

auto_execute = [
    "Fastfetch",
    "Alacritty",
    "Kitty"
]
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.

🛠 Contributing

We welcome contributions from the community! Before you start, please review our Contributing Guidelines to understand how to make the most effective and efficient contributions.

Official LinUtil Roadmap

Docs are now here

🏅 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

📜 Contributor Milestones