6b572b1ab4
Changes: Separate cli flags and put them in their own module. Add a rustfmt configuration file for grouping imports into crates (so we dont have to do this manually, and it seems we were already doing it manually so might as well) Use comments to describe cli flags instead of using ugly syntax (they both work the same but one is less ugly and more readable) Add a --mouse flag to enable mouse interaction (mouse interaction is now off by default) Add a --bypass-root flag to disable the annoying popup when you run the utility as root Fix an issue where you can't reach the bottom of the list in a subdir (i also reduced the nesting in those functions as well for readability) Add help feature to clap dependency to enable --help / -h Add usage feature to clap dependency to enable usage example when running with --help / -h Remove CLI arg examples from readme, and add instructions on how to view them on CLI to prevent it from bloating up the readme |
||
|---|---|---|
| .cargo | ||
| .github | ||
| core | ||
| docs | ||
| man | ||
| tui | ||
| xtask | ||
| _typos.toml | ||
| .gitignore | ||
| .shellcheckrc | ||
| Cargo.lock | ||
| Cargo.toml | ||
| LICENSE | ||
| linutil.desktop | ||
| README.md | ||
| rustfmt.toml | ||
| start.sh | ||
| startdev.sh | ||
Chris Titus Tech's Linux Utility
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
View available options by running:
linutil --help
For installer options:
curl -fsSL https://christitus.com/linux | sh -s -- --help
⬇️ Installation
Linutil is also available as a package in various repositories:
Arch Linux
Linutil can be installed on Arch Linux with three different AUR packages:
linutil- Stable release compiled from sourcelinutil-bin- Stable release pre-compiledlinutil-git- Compiled from the last commit (not recommended)
by running:
git clone https://aur.archlinux.org/<package>.git
cd <package>
makepkg -si
Replace <package> with your preferred package.
If you use yay, paru or any other AUR Helper, it's even simpler:
paru -S linutil
Replace paru with your preferred helper and linutil with your preferred package.
OpenSUSE
Linutil can be installed on OpenSUSE with:
sudo zypper install linutil
Cargo
Linutil can be installed via Cargo with:
cargo install linutil_tui
Note that crates installed using cargo install require manual updating with cargo install --force (update functionality is included in LinUtil)
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:
# 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.
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!
📜 Contributor Milestones
- 2024/07 - Original Linutil Rust TUI was developed by @JustLinuxUser.
- 2024/09 - TabList (Left Column) and various Rust Core/TUI Improvements developed by @lj3954
- 2024/09 - Cargo Publish, AUR, Rust, and Bash additions done by @adamperkowski
- 2024/09 - Rust TUI Min/Max, MultiSelection, and Bash additions done by @jeevithakannan2
- 2024/09 - Various bash updates and standardization done by @nnyyxxxx
- 2024/09 - Multiple bash script additions done by @guruswarupa