mirror of
https://github.com/ChrisTitusTech/linutil.git
synced 2024-11-25 14:30:11 +00:00
Merge 81ba99beec into 8ea3da9843
This commit is contained in:
Real-MullaC
GitHub
commit
bbaa44d221
89
.github/mkdocs.yml
vendored
89
.github/mkdocs.yml
vendored
|
|
@ -1,89 +0,0 @@
|
||||||
site_name: Chris Titus LinUtil Official Documentation
|
|
||||||
repo_url: https://github.com/ChrisTitusTech/linutil
|
|
||||||
docs_dir: '../docs'
|
|
||||||
|
|
||||||
nav:
|
|
||||||
- Introduction: 'index.md'
|
|
||||||
- User Guide: 'userguide.md'
|
|
||||||
- Contributing:
|
|
||||||
- Contributing Guide: 'contributing.md'
|
|
||||||
- Roadmap: 'roadmap.md'
|
|
||||||
- Documentation:
|
|
||||||
- Known Issues: 'KnownIssues.md'
|
|
||||||
- FAQ: 'faq.md'
|
|
||||||
|
|
||||||
theme:
|
|
||||||
name: material
|
|
||||||
custom_dir: '../overrides'
|
|
||||||
features:
|
|
||||||
- navigation.tabs
|
|
||||||
- navigation.sections
|
|
||||||
- toc.integrate
|
|
||||||
- navigation.top
|
|
||||||
- search.suggest
|
|
||||||
- search.highlight
|
|
||||||
- content.tabs.link
|
|
||||||
- content.code.annotation
|
|
||||||
- content.code.copy
|
|
||||||
language: en
|
|
||||||
logo: assets/favicon.png
|
|
||||||
favicon: assets/favicon.png
|
|
||||||
palette:
|
|
||||||
# Palette toggle for automatic mode
|
|
||||||
- media: "(prefers-color-scheme)"
|
|
||||||
toggle:
|
|
||||||
icon: material/brightness-auto
|
|
||||||
name: Switch to light mode
|
|
||||||
|
|
||||||
# Palette toggle for light mode
|
|
||||||
- media: "(prefers-color-scheme: light)"
|
|
||||||
scheme: default
|
|
||||||
accent: blue
|
|
||||||
toggle:
|
|
||||||
icon: material/brightness-7
|
|
||||||
name: Switch to dark mode
|
|
||||||
|
|
||||||
# Palette toggle for dark mode
|
|
||||||
- media: "(prefers-color-scheme: dark)"
|
|
||||||
scheme: slate
|
|
||||||
primary: black
|
|
||||||
accent: blue
|
|
||||||
toggle:
|
|
||||||
icon: material/weather-night
|
|
||||||
name: Switch to light mode
|
|
||||||
markdown_extensions:
|
|
||||||
- admonition
|
|
||||||
- pymdownx.details
|
|
||||||
- pymdownx.superfences
|
|
||||||
- pymdownx.superfences:
|
|
||||||
custom_fences:
|
|
||||||
- name: mermaid
|
|
||||||
class: mermaid
|
|
||||||
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
||||||
- abbr
|
|
||||||
- attr_list
|
|
||||||
- pymdownx.snippets
|
|
||||||
- md_in_html
|
|
||||||
- pymdownx.superfences
|
|
||||||
- pymdownx.tabbed:
|
|
||||||
alternate_style: true
|
|
||||||
- pymdownx.highlight:
|
|
||||||
anchor_linenums: true
|
|
||||||
line_spans: __span
|
|
||||||
pygments_lang_class: true
|
|
||||||
- pymdownx.inlinehilite
|
|
||||||
- def_list
|
|
||||||
- pymdownx.tasklist:
|
|
||||||
custom_checkbox: true
|
|
||||||
- toc:
|
|
||||||
permalink: true
|
|
||||||
|
|
||||||
plugins:
|
|
||||||
- search
|
|
||||||
- awesome-pages
|
|
||||||
- git-revision-date-localized
|
|
||||||
- minify:
|
|
||||||
minify_html: true
|
|
||||||
htmlmin_opts:
|
|
||||||
remove_comments: true
|
|
||||||
cache_safe: true
|
|
||||||
|
Before Width: | Height: | Size: 1.3 MiB After Width: | Height: | Size: 1.3 MiB |
56
.github/workflows/github-pages.yml
vendored
56
.github/workflows/github-pages.yml
vendored
|
|
@ -1,56 +0,0 @@
|
||||||
name: GitHub Pages Deploy
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
paths:
|
|
||||||
- '.github/mkdocs.yml'
|
|
||||||
- '.github/requirements.txt'
|
|
||||||
- 'docs/**'
|
|
||||||
- 'overrides/**'
|
|
||||||
- '.github/CONTRIBUTING.md'
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build-and-deploy:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
environment: linutil_env
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
pull-requests: write
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checkout Repository
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: '0' # Fetch all commit history for all branches as well as tags.
|
|
||||||
|
|
||||||
- name: Copy Contributing Guidelines
|
|
||||||
run: |
|
|
||||||
echo -e "<!-- THIS FILE IS GENERATED AUTOMATICALLY. EDIT .github/CONTRIBUTING.md -->\n\n$(cat .github/CONTRIBUTING.md)" > 'docs/contributing.md'
|
|
||||||
|
|
||||||
- name: Create Pull Request
|
|
||||||
uses: peter-evans/create-pull-request@v6
|
|
||||||
with:
|
|
||||||
commit-message: Update Contributing Guidelines
|
|
||||||
title: 'docs: Update Contributing Guidelines'
|
|
||||||
body: 'Automated update of Contributing Guidelines from .github/CONTRIBUTING.md'
|
|
||||||
branch: update-contributing-guidelines
|
|
||||||
delete-branch: true
|
|
||||||
base: main
|
|
||||||
labels: documentation
|
|
||||||
token: ${{ secrets.PAT_TOKEN }}
|
|
||||||
if: success()
|
|
||||||
|
|
||||||
- name: Setup Python
|
|
||||||
uses: actions/setup-python@v5
|
|
||||||
with:
|
|
||||||
python-version: 3.x # Install latest Stable release of Python 3
|
|
||||||
cache: 'pip' # Caching pip dependencies
|
|
||||||
|
|
||||||
- name: Install Necessary Dependencies
|
|
||||||
run: pip install -r .github/requirements.txt
|
|
||||||
|
|
||||||
- name: Build & Deploy using mkdocs
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
run: mkdocs gh-deploy --force -f .github/mkdocs.yml
|
|
||||||
6
.github/workflows/preview.yml
vendored
6
.github/workflows/preview.yml
vendored
|
|
@ -59,16 +59,16 @@ jobs:
|
||||||
- name: Generate preview
|
- name: Generate preview
|
||||||
uses: charmbracelet/vhs-action@v2.1.0
|
uses: charmbracelet/vhs-action@v2.1.0
|
||||||
with:
|
with:
|
||||||
path: "docs/assets/preview.tape"
|
path: ".github/preview.tape"
|
||||||
|
|
||||||
- name: Move preview
|
- name: Move preview
|
||||||
run: mv preview.gif docs/assets/preview.gif
|
run: mv preview.gif .github/preview.gif
|
||||||
|
|
||||||
- name: Create PR
|
- name: Create PR
|
||||||
uses: peter-evans/create-pull-request@v7.0.5
|
uses: peter-evans/create-pull-request@v7.0.5
|
||||||
with:
|
with:
|
||||||
commit-message: Preview for ${{ env.tag_name }}
|
commit-message: Preview for ${{ env.tag_name }}
|
||||||
file-pattern: "docs/assets/preview.gif"
|
file-pattern: ".github/preview.gif"
|
||||||
add-options: "--force"
|
add-options: "--force"
|
||||||
token: ${{ secrets.PAT_TOKEN }}
|
token: ${{ secrets.PAT_TOKEN }}
|
||||||
branch: feature/preview-${{ env.tag_name }}
|
branch: feature/preview-${{ env.tag_name }}
|
||||||
|
|
|
||||||
58
.github/workflows/xtask.yml
vendored
58
.github/workflows/xtask.yml
vendored
|
|
@ -1,58 +0,0 @@
|
||||||
name: XTasks
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- "xtask"
|
|
||||||
- "Cargo.toml"
|
|
||||||
- "Cargo.lock"
|
|
||||||
- ".cargo"
|
|
||||||
- "core/tabs"
|
|
||||||
- "docs"
|
|
||||||
push:
|
|
||||||
paths:
|
|
||||||
- "xtask"
|
|
||||||
- "Cargo.toml"
|
|
||||||
- "Cargo.lock"
|
|
||||||
- ".cargo"
|
|
||||||
- "core/tabs"
|
|
||||||
- "docs"
|
|
||||||
|
|
||||||
env:
|
|
||||||
CARGO_TERM_COLOR: always
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
docgen:
|
|
||||||
name: DocGen
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checkout sources
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Install Rust
|
|
||||||
uses: dtolnay/rust-toolchain@stable
|
|
||||||
|
|
||||||
- name: Cache Cargo registry
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: ~/.cargo/registry
|
|
||||||
key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
|
|
||||||
restore-keys: ${{ runner.os }}-cargo-registry-
|
|
||||||
|
|
||||||
- name: Cache Cargo index
|
|
||||||
uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: ~/.cargo/git
|
|
||||||
key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }}
|
|
||||||
restore-keys: ${{ runner.os }}-cargo-index-
|
|
||||||
|
|
||||||
- name: Run cargo xtask docgen
|
|
||||||
run: cargo xtask docgen
|
|
||||||
|
|
||||||
- name: Check uncommitted documentation changes
|
|
||||||
run: |
|
|
||||||
git diff
|
|
||||||
git diff-files --quiet \
|
|
||||||
|| (echo "Run 'cargo xtask docgen' and push the changes" \
|
|
||||||
&& exit 1)
|
|
||||||
|
|
@ -7,7 +7,7 @@
|
||||||
<!-- TODO: crates.io package here + <br> -->
|
<!-- TODO: crates.io package here + <br> -->
|
||||||
[](https://crates.io/crates/linutil_tui) [](https://aur.archlinux.org/packages/linutil) [](https://aur.archlinux.org/packages/linutil-bin)
|
[](https://crates.io/crates/linutil_tui) [](https://aur.archlinux.org/packages/linutil) [](https://aur.archlinux.org/packages/linutil-bin)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
**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.
|
**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.
|
||||||
|
|
||||||
|
|
@ -78,13 +78,15 @@ If you find Linutil helpful, please consider giving it a ⭐️ to show your sup
|
||||||
|
|
||||||
## 🎓 Documentation
|
## 🎓 Documentation
|
||||||
|
|
||||||
For comprehensive information on how to use Linutil, visit the [Linutil Official Documentation](https://christitustech.github.io/linutil/).
|
For comprehensive information on how to use Linutil, visit the [Linutil Official Documentation](https://chris-titus-docs.github.io/linutil-docs/).
|
||||||
|
|
||||||
## 🛠 Contributing
|
## 🛠 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.
|
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://christitustech.github.io/linutil/roadmap)
|
[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
|
## 🏅 Thanks to All Contributors
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,4 +0,0 @@
|
||||||
# Known Issues
|
|
||||||
---
|
|
||||||
|
|
||||||
- [Known Issues](https://github.com/ChrisTitusTech/linutil/issues)
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 9.6 KiB |
|
|
@ -1,89 +0,0 @@
|
||||||
# VHS documentation
|
|
||||||
#
|
|
||||||
# Output:
|
|
||||||
# Output <path>.gif Create a GIF output at the given <path>
|
|
||||||
# Output <path>.mp4 Create an MP4 output at the given <path>
|
|
||||||
# Output <path>.webm Create a WebM output at the given <path>
|
|
||||||
#
|
|
||||||
# Require:
|
|
||||||
# Require <string> Ensure a program is on the $PATH to proceed
|
|
||||||
#
|
|
||||||
# Settings:
|
|
||||||
# Set FontSize <number> Set the font size of the terminal
|
|
||||||
# Set FontFamily <string> Set the font family of the terminal
|
|
||||||
# Set Height <number> Set the height of the terminal
|
|
||||||
# Set Width <number> Set the width of the terminal
|
|
||||||
# Set LetterSpacing <float> Set the font letter spacing (tracking)
|
|
||||||
# Set LineHeight <float> Set the font line height
|
|
||||||
# Set LoopOffset <float>% Set the starting frame offset for the GIF loop
|
|
||||||
# Set Theme <json|string> Set the theme of the terminal
|
|
||||||
# Set Padding <number> Set the padding of the terminal
|
|
||||||
# Set Framerate <number> Set the framerate of the recording
|
|
||||||
# Set PlaybackSpeed <float> Set the playback speed of the recording
|
|
||||||
# Set MarginFill <file|#000000> Set the file or color the margin will be filled with.
|
|
||||||
# Set Margin <number> Set the size of the margin. Has no effect if MarginFill isn't set.
|
|
||||||
# Set BorderRadius <number> Set terminal border radius, in pixels.
|
|
||||||
# Set WindowBar <string> Set window bar type. (one of: Rings, RingsRight, Colorful, ColorfulRight)
|
|
||||||
# Set WindowBarSize <number> Set window bar size, in pixels. Default is 40.
|
|
||||||
# Set TypingSpeed <time> Set the typing speed of the terminal. Default is 50ms.
|
|
||||||
#
|
|
||||||
# Sleep:
|
|
||||||
# Sleep <time> Sleep for a set amount of <time> in seconds
|
|
||||||
#
|
|
||||||
# Type:
|
|
||||||
# Type[@<time>] "<characters>" Type <characters> into the terminal with a
|
|
||||||
# <time> delay between each character
|
|
||||||
#
|
|
||||||
# Keys:
|
|
||||||
# Escape[@<time>] [number] Press the Escape key
|
|
||||||
# Backspace[@<time>] [number] Press the Backspace key
|
|
||||||
# Delete[@<time>] [number] Press the Delete key
|
|
||||||
# Insert[@<time>] [number] Press the Insert key
|
|
||||||
# Down[@<time>] [number] Press the Down key
|
|
||||||
# Enter[@<time>] [number] Press the Enter key
|
|
||||||
# Space[@<time>] [number] Press the Space key
|
|
||||||
# Tab[@<time>] [number] Press the Tab key
|
|
||||||
# Left[@<time>] [number] Press the Left Arrow key
|
|
||||||
# Right[@<time>] [number] Press the Right Arrow key
|
|
||||||
# Up[@<time>] [number] Press the Up Arrow key
|
|
||||||
# Down[@<time>] [number] Press the Down Arrow key
|
|
||||||
# PageUp[@<time>] [number] Press the Page Up key
|
|
||||||
# PageDown[@<time>] [number] Press the Page Down key
|
|
||||||
# Ctrl+<key> Press the Control key + <key> (e.g. Ctrl+C)
|
|
||||||
#
|
|
||||||
# Display:
|
|
||||||
# Hide Hide the subsequent commands from the output
|
|
||||||
# Show Show the subsequent commands in the output
|
|
||||||
|
|
||||||
Output preview.gif
|
|
||||||
|
|
||||||
Require linutil
|
|
||||||
Require sh
|
|
||||||
|
|
||||||
Set Shell "bash"
|
|
||||||
Set FontFamily "JetBrainsMono Nerd Font"
|
|
||||||
Set FontSize 24
|
|
||||||
Set Width 1920
|
|
||||||
Set Height 1080
|
|
||||||
|
|
||||||
Sleep 1s
|
|
||||||
|
|
||||||
Type "linutil" Sleep 1s Enter
|
|
||||||
|
|
||||||
Sleep 5s
|
|
||||||
|
|
||||||
Left Sleep 2s
|
|
||||||
Down Sleep 1s
|
|
||||||
Down Sleep 1s
|
|
||||||
Down Sleep 1s
|
|
||||||
Down Sleep 2s
|
|
||||||
Right Sleep 3s
|
|
||||||
|
|
||||||
Type "/" Sleep 1s
|
|
||||||
Type@200ms "System Cleanup" Sleep 1s Enter
|
|
||||||
|
|
||||||
Sleep 2s
|
|
||||||
Enter Sleep 3s
|
|
||||||
Type "y" Sleep 15s # CONFIRMATION PROMPT
|
|
||||||
|
|
||||||
Escape
|
|
||||||
|
|
@ -1,72 +0,0 @@
|
||||||
<!-- THIS FILE IS GENERATED AUTOMATICALLY. EDIT .github/CONTRIBUTING.md -->
|
|
||||||
|
|
||||||
# Contributing Guidelines for Linutil
|
|
||||||
|
|
||||||
Thank you for considering contributing to Linutil! We appreciate your effort in helping improve this project. To ensure that your contributions align with the goals and quality standards of Linutil, please follow these guidelines:
|
|
||||||
|
|
||||||
## 1. **Install Rust**:
|
|
||||||
|
|
||||||
Make sure you have Rust installed on your machine. You can install it by following the instructions at [rust-lang.org](https://www.rust-lang.org/tools/install).
|
|
||||||
|
|
||||||
## 2. **Fork and Clone the repo**
|
|
||||||
|
|
||||||
1. Make a fork of the repo in GitHub
|
|
||||||
2. Clone the fork
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/YOUR_USERNAME_HERE/linutil.git
|
|
||||||
cd linutil
|
|
||||||
```
|
|
||||||
|
|
||||||
## 3. Make your changes
|
|
||||||
|
|
||||||
- **Edit the files you want to change**: Make your changes to the relevant files.
|
|
||||||
- **Test your changes**: Run `cargo run` to test your modifications in a local environment and ensure everything works as expected.
|
|
||||||
|
|
||||||
## 4. Understand the existing code
|
|
||||||
|
|
||||||
- **Have a clear reason**: Don’t change the way things are done without a valid reason. If you propose an alteration, be prepared to explain why it’s necessary and how it improves the project.
|
|
||||||
- **Respect existing conventions**: Changes should align with the existing code style, design patterns, and overall project philosophy. If you want to introduce a new way of doing things, justify it clearly.
|
|
||||||
|
|
||||||
## 5. Learn from Past Pull Requests (PRs)
|
|
||||||
|
|
||||||
- **Check merged PRs**: Reviewing merged pull requests can give you an idea of what kind of contributions are accepted and how they are implemented.
|
|
||||||
- **Study rejected PRs**: This is especially important as it helps you avoid making similar mistakes or proposing changes that have already been considered and declined.
|
|
||||||
|
|
||||||
## 6. Write Clean, Descriptive Commit Messages
|
|
||||||
|
|
||||||
- **Be descriptive**: Your commit messages should clearly describe what the change does and why it was made.
|
|
||||||
- **Use the imperative mood**: For example, "Add feature X" or "Fix bug in Y", rather than "Added feature X" or "Fixed bug in Y".
|
|
||||||
- **Keep commits clean**: Avoid committing a change and then immediately following it with a fix for that change. Instead, amend your commit or squash it if needed.
|
|
||||||
|
|
||||||
## 7. Keep Your Pull Requests (PRs) Small and Focused
|
|
||||||
|
|
||||||
- **Make small, targeted PRs**: Focus on one feature or fix per pull request. This makes it easier to review and increases the likelihood of acceptance.
|
|
||||||
- **Avoid combining unrelated changes**: PRs that tackle multiple unrelated issues are harder to review and might be rejected because of a single problem.
|
|
||||||
|
|
||||||
## 8. Understand and Test the Code You Write
|
|
||||||
|
|
||||||
- **Review your code**: Before submitting your changes, take the time to review your code for readability, efficiency and performance. Consider how your changes affect the project.
|
|
||||||
- **Avoid using LLMs**: Don't submit AI-generated code without reviewing and testing it first. Ensure that any code you submit is thoroughly understood and meets the project's standards.
|
|
||||||
- **Testing Requirements**: Failure to conduct testing after multiple requests may result in the closure of your Pull Request.
|
|
||||||
|
|
||||||
## 9. Code Review and Feedback
|
|
||||||
|
|
||||||
- **Expect feedback**: PRs will undergo code review. Be open to feedback and willing to make adjustments as needed.
|
|
||||||
- **Participate in reviews**: If you feel comfortable, review other contributors' PRs as well. Peer review is a great way to learn and ensure high-quality contributions.
|
|
||||||
|
|
||||||
## 10. Contributing Is More Than Just Code
|
|
||||||
|
|
||||||
- **Test the tool**: Running tests and providing feedback on how the tool works in different environments is a valuable contribution.
|
|
||||||
- **Write well-formed issues**: Clearly describe bugs or problems you encounter, providing as much detail as possible, including steps to reproduce the issue.
|
|
||||||
- **Propose reasonable feature requests**: When suggesting new features, ensure they fit within the scope, style, and design of the project. Provide clear reasoning and use cases.
|
|
||||||
|
|
||||||
## 11. Documentation
|
|
||||||
|
|
||||||
- **Update the documentation**: If your change affects the functionality, please update the relevant documentation files to reflect this.
|
|
||||||
- **Automatic generation**: If you decide to add functionality through a new shell script, make sure to fill out all fields in `tab_data.toml` and run `cargo xtask docgen`.
|
|
||||||
|
|
||||||
## 12. License
|
|
||||||
|
|
||||||
- **Agree to the license**: By contributing to Linutil, you agree that your contributions will be licensed under the project's MIT license.
|
|
||||||
|
|
||||||
We appreciate your contributions and look forward to collaborating with you to make Linutil better!
|
|
||||||
|
|
@ -1,4 +0,0 @@
|
||||||
# FAQ's
|
|
||||||
|
|
||||||
## How do I uninstall LinUtil?
|
|
||||||
* You do not have to uninstall LinUtil. As it is a script you run from your terminal it only loads into your RAM. This means as soon as you close LinUtil it will be deleted off your system.
|
|
||||||
|
|
@ -1,76 +0,0 @@
|
||||||
# Welcome to the LinUtil Documentation!
|
|
||||||
|
|
||||||
[](https://github.com/ChrisTitusTech/linutil/releases/latest)
|
|
||||||
|
|
||||||
[](https://discord.gg/bujFYKAHSp)
|
|
||||||
|
|
||||||
[](https://crates.io/crates/linutil_tui) [](https://aur.archlinux.org/packages/linutil) [](https://aur.archlinux.org/packages/linutil-bin)
|
|
||||||
|
|
||||||
## Running the latest release of LinUtil
|
|
||||||
|
|
||||||
To get started, run the following command in your terminal:
|
|
||||||
|
|
||||||
### Stable branch
|
|
||||||
|
|
||||||
```
|
|
||||||
curl -fsSL https://christitus.com/linux | sh
|
|
||||||
```
|
|
||||||
---
|
|
||||||
|
|
||||||
### Installation
|
|
||||||
|
|
||||||
LinUtil is also available as a package in various repositories:
|
|
||||||
|
|
||||||
[](https://repology.org/project/linutil/versions)
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Arch Linux</summary>
|
|
||||||
|
|
||||||
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/<package>.git
|
|
||||||
cd linutil
|
|
||||||
makepkg -si
|
|
||||||
```
|
|
||||||
|
|
||||||
Replace `<package>` 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.
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Cargo</summary>
|
|
||||||
|
|
||||||
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))
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
After you've ran the command, you should see a GUI on your screen; It will look something like this:
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
!!! info
|
|
||||||
|
|
||||||
LinUtil is updated weekly as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.
|
|
||||||
|
|
@ -1,27 +0,0 @@
|
||||||
# Roadmap
|
|
||||||
|
|
||||||
## Vision
|
|
||||||
- To simplify linux tasks for all users for all distributions; Easily, efficiently, and effortlessly.
|
|
||||||
|
|
||||||
## Goals
|
|
||||||
- [ ] Focus on tasks that take time in Linux and automate them. (Example: Removing a user, adding a user, etc. - but mostly BASH scripts with POSIX compliance.)
|
|
||||||
- [x] Remove Binary linutil from being tracked in git and make it a github action.
|
|
||||||
- [ ] Document every function and feature of linutil. (Preview panel description addition)
|
|
||||||
- [x] Create a discord server for linutil and invite the community.
|
|
||||||
- [x] Power Optimizations for Laptops
|
|
||||||
|
|
||||||
## Milestones
|
|
||||||
### Q4 2024
|
|
||||||
- [x] Finish the foundation of the project's CLI
|
|
||||||
- [ ] Implement CLI arguments and configuration support
|
|
||||||
- [ ] Add an option for logging script executions
|
|
||||||
|
|
||||||
### Q1 2025
|
|
||||||
- [ ] GUI Brainstorming and Planning
|
|
||||||
- [ ] Basic GUI Implementation
|
|
||||||
|
|
||||||
### Q2 2025
|
|
||||||
- [ ] Full GUI Implementation
|
|
||||||
|
|
||||||
## Community Feedback
|
|
||||||
- Encourage community input and suggestions for future development.
|
|
||||||
|
|
@ -1,136 +0,0 @@
|
||||||
<!-- THIS FILE IS GENERATED BY cargo xtask docgen -->
|
|
||||||
# Walkthrough
|
|
||||||
|
|
||||||
## Applications Setup
|
|
||||||
|
|
||||||
|
|
||||||
### Communication Apps
|
|
||||||
|
|
||||||
- **Discord**: Discord is a versatile communication platform for gamers and communities, offering voice, video, and text chat features.
|
|
||||||
- **Jitsi**: Jitsi Meet is an open-source video conferencing tool that allows users to host and join secure meetings directly from their web browsers without the need for downloads.
|
|
||||||
- **Signal**: Signal is a privacy-focused messaging app that provides end-to-end encryption for secure text, voice, and video communication.
|
|
||||||
- **Slack**: Slack is a collaboration platform designed for team communication, featuring channels, direct messaging, file sharing, and integrations with various productivity tools.
|
|
||||||
- **Telegram**: Telegram is a cloud-based messaging app known for its speed and security, offering features like group chats, channels, and end-to-end encrypted calls.
|
|
||||||
- **Thunderbird**: Thunderbird is a free, open-source email client that offers powerful features like customizable email management, a built-in calendar, and extensive add-ons for enhanced functionality.
|
|
||||||
- **Zoom**: Zoom is a widely-used video conferencing platform that allows users to host virtual meetings, webinars, and online collaboration with features like screen sharing and recording.
|
|
||||||
|
|
||||||
### Developer Tools
|
|
||||||
|
|
||||||
- **Github Desktop**: GitHub Desktop is a user-friendly application that simplifies the process of managing Git repositories and interacting with GitHub, providing a graphical interface for tasks like committing, branching, and syncing changes.
|
|
||||||
- **JetBrains Toolbox**: JetBrains Toolbox is a collection of tools and an app that help developers work with JetBrains products.
|
|
||||||
- **Meld**: Meld is a visual diff and merge tool that helps compare files, directories, and version-controlled projects.
|
|
||||||
- **Neovim**: Neovim is a refactor, and sometimes redactor, in the tradition of Vim.
|
|
||||||
It is not a rewrite but a continuation and extension of Vim.
|
|
||||||
This command configures neovim from CTT's neovim configuration.
|
|
||||||
https://github.com/ChrisTitusTech/neovim
|
|
||||||
- **Ngrok**: Ngrok is a tool that creates secure, temporary tunnels to expose local servers to the internet for testing and development.
|
|
||||||
- **Sublime Text**: Sublime Text is a fast, lightweight, and customizable text editor known for its simplicity, powerful features, and wide range of plugins for various programming languages.
|
|
||||||
- **VS Code**: Visual Studio Code (VS Code) is a lightweight, open-source code editor with built-in support for debugging, version control, and extensions for various programming languages and frameworks.
|
|
||||||
- **VS Codium**: VSCodium is a free, open-source version of Visual Studio Code (VS Code) that removes Microsoft-specific telemetry and branding.
|
|
||||||
|
|
||||||
### Office Suites
|
|
||||||
|
|
||||||
|
|
||||||
### PDF Suites
|
|
||||||
|
|
||||||
|
|
||||||
### Web Browsers
|
|
||||||
|
|
||||||
- **Brave**: Brave is a free and open-source web browser developed by Brave Software, Inc. based on the Chromium web browser.
|
|
||||||
- **Chromium**: Chromium is an open-source web browser project started by Google, to provide the source code for the proprietary Google Chrome browser.
|
|
||||||
- **Google Chrome**: Google Chrome is a fast, secure, and free web browser, built for the modern web.
|
|
||||||
- **LibreWolf**: LibreWolf is a fork of Firefox, focused on privacy, security, and freedom.
|
|
||||||
- **Lynx**: Lynx is a highly configurable text-based web browser for use on cursor-addressable character cell terminals.
|
|
||||||
- **Mozilla Firefox**: Mozilla Firefox is a free and open-source web browser developed by the Mozilla Foundation.
|
|
||||||
- **Thorium**: Thorium is a Chromium-based browser focused on privacy and performance.
|
|
||||||
- **Vivaldi**: Vivaldi is a freeware, cross-platform web browser developed by Vivaldi Technologies.
|
|
||||||
- **waterfox**: Waterfox is the privacy-focused web browser engineered to give you speed, control, and peace of mind on the internet.
|
|
||||||
- **Alacritty**: Alacritty is a modern terminal emulator that comes with sensible defaults, but allows for extensive configuration. By integrating with other applications, rather than reimplementing their functionality, it manages to provide a flexible set of features with high performance. The supported platforms currently consist of BSD, Linux, macOS and Windows. This command installs and configures alacritty terminal emulator.
|
|
||||||
- **Android Debloater**: Universal Android Debloater (UAD) is a tool designed to help users remove bloatware and unnecessary pre-installed applications from Android devices, enhancing performance and user experience.
|
|
||||||
- **Bash Prompt**: The .bashrc file is a script that runs every time a new terminal session is started in Unix-like operating systems. It is used to configure the shell session, set up aliases, define functions, and more, making the terminal easier to use and more powerful. This command configures the key sections and functionalities defined in the .bashrc file from CTT's mybash repository. https://github.com/ChrisTitusTech/mybash
|
|
||||||
- **Bottles**: Bottles allows Windows software, like applications and games, to run on Linux. Bottles also provides tools to categorize, organize and optimize your applications.
|
|
||||||
- **Docker**: Docker is an open platform that uses OS-level virtualization to deliver software in packages called containers.
|
|
||||||
- **DWM-Titus**: DWM is a dynamic window manager for X.
|
|
||||||
It manages windows in tiled, monocle and floating layouts.
|
|
||||||
All of the layouts can be applied dynamically, optimising the environment for the application in use and the task performed.
|
|
||||||
This command installs and configures DWM and a desktop manager.
|
|
||||||
The list of patches applied can be found in CTT's DWM repository
|
|
||||||
https://github.com/ChrisTitusTech/dwm-titus
|
|
||||||
- **Docker**: Docker is an open platform that uses OS-level virtualization to deliver software in packages called containers.
|
|
||||||
- **Podman**: Podman is a daemon-less open platform that uses OS-level virtualization to deliver software in packages called containers.
|
|
||||||
- **Podman-compose**: Podman Compose is a tool for defining and running multi-container applications using Podman.
|
|
||||||
- **Fastfetch**: Fastfetch is a neofetch-like tool for fetching system information and displaying it prettily. It is written mainly in C, with performance and customizability in mind. This command installs fastfetch and configures from CTT's mybash repository. https://github.com/ChrisTitusTech/mybash
|
|
||||||
- **Flatpak / Flathub**: Flatpak is a universal application sandbox for Linux that uses isolated packages from Flathub to prevent conflicts and system alterations, while alleviating dependency concerns. This command installs Flatpak and adds the Flathub repository
|
|
||||||
- **Grub Theme**: Installs ChrisTitusTech's Top 5 Bootloader Themes script to allow for easy customization of GRUB.
|
|
||||||
- **Kitty**: kitty is a free and open-source GPU-accelerated terminal emulator for Linux, macOS, and some BSD distributions, focused on performance and features. kitty is written in a mix of C and Python programming languages. This command installs and configures kitty.
|
|
||||||
- **Linutil Installer**: Installs a distro-specific Linutil package locally.
|
|
||||||
- **Linutil Updater**: Updates your local Linutil crate installation.
|
|
||||||
- **Rofi**: Rofi is a window switcher, run dialog, ssh-launcher and dmenu replacement that started as a clone of simpleswitcher, written by Sean Pringle and later expanded by Dave Davenport. This command installs and configures rofi with configuration from CTT's DWM repo. https://github.com/ChrisTitusTech/dwm-titus
|
|
||||||
- **Waydroid**: Waydroid is an emulator that allows you to run Android apps and games on Linux.
|
|
||||||
- **ZSH Prompt**: The Z shell is a Unix shell that can be used as an interactive login shell and as a command interpreter for shell scripting. Zsh is an extended Bourne shell with many improvements, including some features of Bash, ksh, and tcsh. This command installs ZSH prompt and provides basic configuration.
|
|
||||||
|
|
||||||
## Gaming
|
|
||||||
|
|
||||||
|
|
||||||
### Diablo II Resurrected
|
|
||||||
|
|
||||||
- **Loot Filter**: This is a loot filter for Diablo II Resurrected. It's designed to be a simple, clean, and easy to read loot filter that highlights the most important items. Works on battle.net and single player. No frills, no config, just highlights high runes and other valuable items. For more information visit: https://github.com/ChrisTitusTech/d2r-loot-filter
|
|
||||||
|
|
||||||
## Security
|
|
||||||
|
|
||||||
- **Firewall Baselines (CTT)**: Developed to ease iptables firewall configuration, UFW provides a user friendly way to create an IPv4 or IPv6 host-based firewall. This command installs UFW and configures UFW based on CTT's recommended rules. For more information visit: https://christitus.com/linux-security-mistakes
|
|
||||||
|
|
||||||
## System Setup
|
|
||||||
|
|
||||||
|
|
||||||
### Arch Linux
|
|
||||||
|
|
||||||
- **Arch Server Setup**: This command installs a minimal arch server setup under 5 minutes.
|
|
||||||
- **Linux Neptune for SteamDeck**: Valve's fork of Linux Kernel for the SteamDeck
|
|
||||||
- **Nvidia Drivers && Hardware Acceleration**: This script installs and configures nvidia drivers with Hardware Acceleration.
|
|
||||||
- **Paru AUR Helper**: Paru is your standard pacman wrapping AUR helper with lots of features and minimal interaction. To know more about AUR helpers visit: https://wiki.archlinux.org/title/AUR_helpers
|
|
||||||
- **Yay AUR Helper**: Yet Another Yogurt - An AUR Helper Written in Go. To know more about AUR helpers visit: https://wiki.archlinux.org/title/AUR_helpers
|
|
||||||
|
|
||||||
### Fedora
|
|
||||||
|
|
||||||
- **Configure DNF**: Optimizes DNF for parallel downloads
|
|
||||||
- **Multimedia Codecs**: This script is designed to install multimedia codecs, and to ensure RPM Fusion repositories are installed.
|
|
||||||
- **Nvidia Proprietary Drivers**: This script is designed to download the proprietary NVIDIA drivers in Fedora.
|
|
||||||
- **RPM Fusion**: RPM Fusion provides software that the Fedora Project or Red Hat doesn't want to ship. That software is provided as precompiled RPMs for all current Fedora versions and current Red Hat Enterprise Linux or clones versions; you can use the RPM Fusion repositories with tools like yum and PackageKit. For more information visit: https://rpmfusion.org/
|
|
||||||
- **Upgrade to a New Fedora Release**: Upgrades system to the next Fedora release
|
|
||||||
- **Virtualization**: Enables Virtualization through dnf
|
|
||||||
- **Btrfs Assistant, Snapper Config, grub-btrfs**: Installs Btrfs Assistant, Snapper, dnf snapper plugin and takes the first root(/) and /home snapshots. Enables snapper-timeline and snapper-cleanup services. Installs Grub-Btrfs. Notice: To perform a system recovery via grub-btrfs, perform a restore operation with Btrfs Assistant GUI after booting into the snapshot. Notice: If you used the default Fedora disk partitioning during OS installation, the /boot configured as an separate EXT4 partition. Therefore, it cannot be included in root snapshots. Backup separately.
|
|
||||||
- **Build Prerequisites**: This script is designed to handle the installation of various software dependencies across different Linux distributions
|
|
||||||
- **Full System Cleanup**: This script is designed to remove unnecessary packages, clean old cache files, remove temporary files, and to empty the trash.
|
|
||||||
- **Full System Update**: This command updates your system to the latest packages available for your distro
|
|
||||||
- **Gaming Dependencies**: This script is designed to handle the installation of gaming dependencies across different Linux distributions
|
|
||||||
- **Global Theme**: This script is designed to handle the installation and configuration of global theming
|
|
||||||
- **Remove Snaps**: This script is designed to remove snap
|
|
||||||
- **TTY Fonts**: This Script will set the default TTY font to Terminus size 32 Bold
|
|
||||||
|
|
||||||
## Utilities
|
|
||||||
|
|
||||||
|
|
||||||
### Monitor Control
|
|
||||||
|
|
||||||
- **Auto Detect Displays**: This script is designed to detect and apply recommended configuration for monitors connected with your system
|
|
||||||
- **Change Orientation**: This script is designed to change the orientation of monitors in your system
|
|
||||||
- **Disable Monitor**: This script is designed to disable a monitor in your system
|
|
||||||
- **Duplicate Displays**: This script is designed to duplicate display among multi-monitor setup in your system
|
|
||||||
- **Enable Monitor**: This script is designed to enable a monitor in your system
|
|
||||||
- **Extend Displays**: This script is designed to extend display among multi-monitor setup in your system
|
|
||||||
- **Manage Arrangement**: This script is designed to arrange monitors in multi-monitor setup in your system
|
|
||||||
- **Reset Scaling**: This script is designed to reset scaling of a monitor in your system
|
|
||||||
- **Scale Monitors**: This script is designed to change the scaling of monitors in your system
|
|
||||||
- **Set Brightness**: This script is designed to change the Brightness of monitors connected to your system
|
|
||||||
- **Set Primary Monitor**: This script is designed to set a Primary monitor in your system
|
|
||||||
- **Set Resolution**: This script is designed to change the resolution of monitors connected to your system
|
|
||||||
|
|
||||||
### User Account Manager
|
|
||||||
|
|
||||||
- **Auto Mount Drive**: This utility is designed to help with automating the process of mounting a drive on to your system.
|
|
||||||
- **Bluetooth Manager**: This utility is designed to manage bluetooth in your system
|
|
||||||
- **Numlock on Startup**: This utility is designed to enable Num Lock at boot, rather than within desktop environments like KDE or GNOME
|
|
||||||
- **Ollama**: This utility is designed to manage ollama in your system
|
|
||||||
- **Service Manager**: This utility is designed to manage services in your system
|
|
||||||
- **WiFi Manager**: This utility is designed to manage wifi in your system
|
|
||||||
|
|
@ -1,12 +0,0 @@
|
||||||
{% extends "base.html" %}
|
|
||||||
|
|
||||||
{% block header %}
|
|
||||||
{{ super() }}
|
|
||||||
<div style="color: red; text-align: center; padding: 10px; font-size: 20px;">
|
|
||||||
<strong>Announcement:</strong> This documentation is still in progress.
|
|
||||||
</div>
|
|
||||||
{% endblock %}
|
|
||||||
|
|
||||||
{% block footer %}
|
|
||||||
{# Empty block to override the footer #}
|
|
||||||
{% endblock %}
|
|
||||||
Loading…
Reference in New Issue
Block a user