mitsuo_makuda/linutil
1
0
Fork 0
mirror of https://github.com/ChrisTitusTech/linutil.git synced 2024-11-22 05:12:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'upstream/main' into refactor_tempdir

Browse Source
This commit is contained in:
Liam 2024-10-25 07:21:49 -07:00
commit 51433a9a0d
No known key found for this signature in database
45 changed files with 690 additions and 258 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.cargo/config.toml Normal file
View File

@ -0,0 +1,2 @@
[alias]
xtask = "run --package xtask --"

2
.github/CONTRIBUTING.md vendored
View File

@ -16,6 +16,7 @@ cd linutil
``` ```
## 3. Make your changes ## 3. Make your changes
- **Edit the files you want to change**: Make your changes to the relevant files. - **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. - **Test your changes**: Run `cargo run` to test your modifications in a local environment and ensure everything works as expected.
@ -60,6 +61,7 @@ cd linutil
## 11. Documentation ## 11. Documentation
- **Update the documentation**: If your change affects the functionality, please update the relevant documentation files to reflect this. - **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 ## 12. License

2
.github/mkdocs.yml vendored
View File

@ -6,7 +6,7 @@ nav:
- Introduction: 'index.md' - Introduction: 'index.md'
- User Guide: 'userguide.md' - User Guide: 'userguide.md'
- Contributing: - Contributing:
- Contributing Guide: 'contribute.md' - Contributing Guide: 'contributing.md'
- Roadmap: 'roadmap.md' - Roadmap: 'roadmap.md'
- Documentation: - Documentation:
- Known Issues: 'KnownIssues.md' - Known Issues: 'KnownIssues.md'

11
.github/workflows/github-pages.yml vendored
View File

@ -20,6 +20,17 @@ jobs:
with: with:
fetch-depth: '0' # Fetch all commit history for all branches as well as tags. 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'
- uses: stefanzweifel/git-auto-commit-action@v5
with:
commit_message: Commit Contributing Guidelines
file_pattern: "docs/contributing.md"
add_options: '--force'
if: success()
- name: Setup Python - name: Setup Python
uses: actions/setup-python@v5 uses: actions/setup-python@v5
with: with:

19
.github/workflows/linutil.yml vendored
View File

@ -89,19 +89,20 @@ jobs:
version: ${{ env.version }} version: ${{ env.version }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Install vhs - name: Setup Preview
run: | run: |
wget 'https://github.com/charmbracelet/vhs/releases/download/v0.8.0/vhs_0.8.0_amd64.deb' echo "$(pwd)/build" >> $GITHUB_PATH
sudo apt install -y ffmpeg
sudo snap install ttyd --classic
sudo dpkg -i 'vhs_0.8.0_amd64.deb'
- name: Build the preview - name: Generate preview
uses: charmbracelet/vhs-action@v2.1.0
with:
path: "docs/assets/preview.tape"
- name: Move preview
run: | run: |
export PATH="$(pwd)/build:$PATH" mv preview.gif docs/assets/preview.gif
vhs docs/assets/preview.tape -o docs/assets/preview.gif
- name: Upload the preview - name: Upload preview
uses: stefanzweifel/git-auto-commit-action@v5 uses: stefanzweifel/git-auto-commit-action@v5
with: with:
commit_message: Preview for ${{ env.version }} commit_message: Preview for ${{ env.version }}

43
.github/workflows/shellcheck.yml vendored
View File

@ -14,17 +14,42 @@ jobs:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- run: git fetch origin ${{ github.base_ref }} - run: git fetch origin ${{ github.base_ref }}
- name: Download and set up shellcheck - name: Download, setup, and run ShellCheck
shell: bash {0}
run : | run : |
wget https://github.com/koalaman/shellcheck/releases/download/v0.10.0/shellcheck-v0.10.0.linux.x86_64.tar.xz SC_URL="https://github.com/koalaman/shellcheck/releases/download/v0.10.0/shellcheck-v0.10.0.linux.x86_64.tar.xz"
tar -xf shellcheck-v0.10.0.linux.x86_64.tar.xz curl -fsSL "$SC_URL" | tar -Jx
cd shellcheck-v0.10.0 chmod +x "./shellcheck-v0.10.0/shellcheck"
chmod +x shellcheck
- name: Run shellcheck error=0
run: | files_to_check=$(git diff --name-only origin/${{ github.base_ref }} HEAD core/tabs)
for file in $(git diff --name-only origin/${{ github.base_ref }} HEAD core/tabs); do
for file in $files_to_check; do
if [[ "$file" == *.sh ]] && [[ -f "$file" ]]; then if [[ "$file" == *.sh ]] && [[ -f "$file" ]]; then
./shellcheck-v0.10.0/shellcheck -S error "$file" sc_output=$(./shellcheck-v0.10.0/shellcheck -fgcc -Serror "$file")
iter_safe_parsed_errors=$(echo -e "$sc_output" | sed -n 's/\(.\+\)\:\([0-9]\+\)\:\([0-9]\+\)\: \(.*\)/::error file=\1,line=\2,col=\3::\4/p' | sed 's/ /:space:/g')
for error in $iter_safe_parsed_errors; do
echo "$error" | sed 's/:space:/ /g'
error=1
done
tabs_detected=$(grep -nP '^\t+\S+' "$file")
# fast fail on the action runner would fail immediately if there weren't any tabs found
# this check makes sure that we don't continue if there's something really weird going on
if [ "$?" = "2" ]; then
echo "::error file=$file::There was a critical error while grepping $file, aborting"
exit 1
fi
iter_safe_parsed_tabs_detected=$(echo "$tabs_detected" | sed -n 's,\([0-9]\+\).*,::error file='"$file"'\,line=\1::Found tab indentations,p' | sed 's/ /:space:/g')
for error in $iter_safe_parsed_tabs_detected; do
echo "$error" | sed 's/:space:/ /g'
error=1
done
fi fi
done done
exit $error

15
.github/workflows/typos.yml vendored Normal file
View File

@ -0,0 +1,15 @@
name: Check for typos
on:
[push, pull_request, workflow_dispatch]
jobs:
check-typos:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: git fetch origin ${{ github.base_ref }}
- name: Run spellcheck
uses: crate-ci/typos@v1.25.0

58
.github/workflows/xtask.yml vendored Normal file
View File

@ -0,0 +1,58 @@
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)

43
Cargo.lock generated
View File

@ -165,9 +165,9 @@ dependencies = [
[[package]] [[package]]
name = "cc" name = "cc"
version = "1.1.18" version = "1.1.28"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b62ac837cdb5cb22e10a256099b4fc502b1dfe560cb282963a974d7abd80e476" checksum = "2e80e3b6a3ab07840e1cae9b0666a63970dc28e8ed5ffbcdacbfc760c281bfc1"
dependencies = [ dependencies = [
"shlex", "shlex",
] ]
@ -194,9 +194,9 @@ dependencies = [
[[package]] [[package]]
name = "clap" name = "clap"
version = "4.5.18" version = "4.5.19"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b0956a43b323ac1afaffc053ed5c4b7c1f1800bacd1683c353aabbb752515dd3" checksum = "7be5744db7978a28d9df86a214130d106a89ce49644cbc4e3f0c22c3fba30615"
dependencies = [ dependencies = [
"clap_builder", "clap_builder",
"clap_derive", "clap_derive",
@ -204,9 +204,9 @@ dependencies = [
[[package]] [[package]]
name = "clap_builder" name = "clap_builder"
version = "4.5.18" version = "4.5.19"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "4d72166dd41634086d5803a47eb71ae740e61d84709c36f3c34110173db3961b" checksum = "a5fbc17d3ef8278f55b282b2a2e75ae6f6c7d4bb70ed3d0382375104bfafdb4b"
dependencies = [ dependencies = [
"anstream", "anstream",
"anstyle", "anstyle",
@ -971,6 +971,12 @@ version = "1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a2eb9349b6444b326872e140eb1cf5e7c522154d69e7a0ffb0fb81c06b37543f" checksum = "a2eb9349b6444b326872e140eb1cf5e7c522154d69e7a0ffb0fb81c06b37543f"
[[package]]
name = "streaming-iterator"
version = "0.1.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2b2231b7c3057d5e4ad0156fb3dc807d900806020c5ffa3ee6ff2c8c76fb8520"
[[package]] [[package]]
name = "strsim" name = "strsim"
version = "0.11.1" version = "0.11.1"
@ -1027,18 +1033,18 @@ dependencies = [
[[package]] [[package]]
name = "thiserror" name = "thiserror"
version = "1.0.63" version = "1.0.64"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c0342370b38b6a11b6cc11d6a805569958d54cfa061a29969c3b5ce2ea405724" checksum = "d50af8abc119fb8bb6dbabcfa89656f46f84aa0ac7688088608076ad2b459a84"
dependencies = [ dependencies = [
"thiserror-impl", "thiserror-impl",
] ]
[[package]] [[package]]
name = "thiserror-impl" name = "thiserror-impl"
version = "1.0.63" version = "1.0.64"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a4558b58466b9ad7ca0f102865eccc95938dca1a74a856f2b57b6629050da261" checksum = "08904e7672f5eb876eaaf87e0ce17857500934f4981c4a0ab2b4aa98baac7fc3"
dependencies = [ dependencies = [
"proc-macro2", "proc-macro2",
"quote", "quote",
@ -1081,13 +1087,14 @@ dependencies = [
[[package]] [[package]]
name = "tree-sitter" name = "tree-sitter"
version = "0.23.0" version = "0.24.2"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "20f4cd3642c47a85052a887d86704f4eac272969f61b686bdd3f772122aabaff" checksum = "23b84f60031bf8245b563a80c92c1034e557a914f7958f474bc0afa2eed78b98"
dependencies = [ dependencies = [
"cc", "cc",
"regex", "regex",
"regex-syntax", "regex-syntax",
"streaming-iterator",
"tree-sitter-language", "tree-sitter-language",
] ]
@ -1103,12 +1110,13 @@ dependencies = [
[[package]] [[package]]
name = "tree-sitter-highlight" name = "tree-sitter-highlight"
version = "0.23.0" version = "0.24.2"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "395d7a477a4504fd7d5e4d003e0dd41bd5b9c4985d53592a943a8354ec452dae" checksum = "5c727fb31f816c09fc54dc0e971d101318926866f7261b2acb820e84a61bf52d"
dependencies = [ dependencies = [
"lazy_static", "lazy_static",
"regex", "regex",
"streaming-iterator",
"thiserror", "thiserror",
"tree-sitter", "tree-sitter",
] ]
@ -1409,6 +1417,13 @@ version = "0.0.19"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d135d17ab770252ad95e9a872d365cf3090e3be864a34ab46f48555993efc904" checksum = "d135d17ab770252ad95e9a872d365cf3090e3be864a34ab46f48555993efc904"
[[package]]
name = "xtask"
version = "24.9.28"
dependencies = [
"linutil_core",
]
[[package]] [[package]]
name = "zerocopy" name = "zerocopy"
version = "0.7.35" version = "0.7.35"

4
Cargo.toml
View File

@ -1,12 +1,14 @@
[workspace.package] [workspace.package]
license = "MIT" license = "MIT"
version = "24.9.28" version = "24.9.28"
edition = "2021"
[workspace.dependencies] [workspace.dependencies]
ego-tree = "0.6.2" ego-tree = "0.6.2"
[workspace] [workspace]
members = ["tui", "core"] members = ["tui", "core", "xtask"]
default-members = ["tui", "core"]
resolver = "2" resolver = "2"
[patch.crates-io] [patch.crates-io]

2
README.md
View File

@ -49,7 +49,7 @@ makepkg -si
Replace `<package>` with your preferred package. 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 simplier: 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 ```bash
paru -S linutil paru -S linutil

7
_typos.toml Normal file
View File

@ -0,0 +1,7 @@
[files]
extend-exclude = ["tui/cool_tips.txt"]
[default]
extend-ignore-identifiers-re = [
"ratatui",
]

62
core/tabs/applications-setup/Developer-tools/sublime-setup.sh
View File

@ -3,37 +3,37 @@
. ../../common-script.sh . ../../common-script.sh
installSublime() { installSublime() {
if ! command_exists sublime; then if ! command_exists sublime; then
printf "%b\n" "${YELLOW}Installing Sublime...${RC}" printf "%b\n" "${YELLOW}Installing Sublime...${RC}"
case "$PACKAGER" in case "$PACKAGER" in
apt-get|nala) apt-get|nala)
curl -fsSL https://download.sublimetext.com/sublimehq-pub.gpg | "$ESCALATION_TOOL" apt-key add - curl -fsSL https://download.sublimetext.com/sublimehq-pub.gpg | "$ESCALATION_TOOL" apt-key add -
echo "deb https://download.sublimetext.com/ apt/stable/" | "$ESCALATION_TOOL" tee /etc/apt/sources.list.d/sublime-text.list echo "deb https://download.sublimetext.com/ apt/stable/" | "$ESCALATION_TOOL" tee /etc/apt/sources.list.d/sublime-text.list
"$ESCALATION_TOOL" "$PACKAGER" update "$ESCALATION_TOOL" "$PACKAGER" update
"$ESCALATION_TOOL" "$PACKAGER" install -y sublime-text "$ESCALATION_TOOL" "$PACKAGER" install -y sublime-text
;; ;;
zypper) zypper)
"$ESCALATION_TOOL" rpm -v --import https://download.sublimetext.com/sublimehq-rpm-pub.gpg "$ESCALATION_TOOL" rpm -v --import https://download.sublimetext.com/sublimehq-rpm-pub.gpg
"$ESCALATION_TOOL" "$PACKAGER" addrepo -g -f https://download.sublimetext.com/rpm/dev/x86_64/sublime-text.repo "$ESCALATION_TOOL" "$PACKAGER" addrepo -g -f https://download.sublimetext.com/rpm/dev/x86_64/sublime-text.repo
"$ESCALATION_TOOL" "$PACKAGER" refresh "$ESCALATION_TOOL" "$PACKAGER" refresh
"$ESCALATION_TOOL" "$PACKAGER" --non-interactive install sublime-text "$ESCALATION_TOOL" "$PACKAGER" --non-interactive install sublime-text
;; ;;
pacman) pacman)
"$AUR_HELPER" -S --needed --noconfirm sublime-text-4 "$AUR_HELPER" -S --needed --noconfirm sublime-text-4
;; ;;
dnf) dnf)
"$ESCALATION_TOOL" rpm -v --import https://download.sublimetext.com/sublimehq-rpm-pub.gpg "$ESCALATION_TOOL" rpm -v --import https://download.sublimetext.com/sublimehq-rpm-pub.gpg
"$ESCALATION_TOOL" "$PACKAGER" config-manager --add-repo https://download.sublimetext.com/rpm/stable/x86_64/sublime-text.repo "$ESCALATION_TOOL" "$PACKAGER" config-manager --add-repo https://download.sublimetext.com/rpm/stable/x86_64/sublime-text.repo
"$ESCALATION_TOOL" "$PACKAGER" install -y sublime-text "$ESCALATION_TOOL" "$PACKAGER" install -y sublime-text
;; ;;
*) *)
printf "%b\n" "${RED}Unsupported package manager: ""$PACKAGER""${RC}" printf "%b\n" "${RED}Unsupported package manager: ""$PACKAGER""${RC}"
exit 1 exit 1
;; ;;
esac esac
else else
printf "%b\n" "${GREEN}Sublime is already installed.${RC}" printf "%b\n" "${GREEN}Sublime is already installed.${RC}"
fi fi
} }

8
core/tabs/applications-setup/grub-theme.sh
View File

@ -4,8 +4,12 @@
themeinstall(){ themeinstall(){
mkdir -p "$HOME/.local/share" mkdir -p "$HOME/.local/share"
cd "$HOME/.local/share" && git clone "https://github.com/ChrisTitusTech/Top-5-Bootloader-Themes" cd "$HOME/.local/share"
cd "$HOME/.local/share/Top-5-Bootloader-Themes" if [ -d 'Top-5-Bootloader-Themes' ]; then
rm -rf 'Top-5-Bootloader-Themes'
fi
git clone "https://github.com/ChrisTitusTech/Top-5-Bootloader-Themes"
cd "Top-5-Bootloader-Themes"
"$ESCALATION_TOOL" ./install.sh "$ESCALATION_TOOL" ./install.sh
} }

15
core/tabs/applications-setup/linutil-installer.sh
View File

@ -35,10 +35,10 @@ installLinutil() {
printf "%b\n" "${YELLOW}Installing rustup...${RC}" printf "%b\n" "${YELLOW}Installing rustup...${RC}"
case "$PACKAGER" in case "$PACKAGER" in
pacman) pacman)
"$ESCALATION_TOOL" "$PACKAGER" -S --needed --noconfirm rustup "$ESCALATION_TOOL" "$PACKAGER" -S --needed --noconfirm curl rustup man-db
;; ;;
dnf) dnf)
"$ESCALATION_TOOL" "$PACKAGER" install -y rustup "$ESCALATION_TOOL" "$PACKAGER" install -y curl rustup man-pages man-db man
;; ;;
zypper) zypper)
"$ESCALATION_TOOL" "$PACKAGER" install -n curl gcc make "$ESCALATION_TOOL" "$PACKAGER" install -n curl gcc make
@ -54,12 +54,23 @@ installLinutil() {
rustup default stable rustup default stable
cargo install --force linutil_tui cargo install --force linutil_tui
printf "%b\n" "${GREEN}Installed successfully.${RC}" printf "%b\n" "${GREEN}Installed successfully.${RC}"
installExtra
;; ;;
*) printf "%b\n" "${RED}Linutil not installed.${RC}" ;; *) printf "%b\n" "${RED}Linutil not installed.${RC}" ;;
esac esac
esac esac
} }
installExtra() {
printf "%b\n" "${YELLOW}Installing the manpage...${RC}"
"$ESCALATION_TOOL" mkdir -p /usr/share/man/man1
curl 'https://raw.githubusercontent.com/ChrisTitusTech/linutil/refs/heads/main/man/linutil.1' | "$ESCALATION_TOOL" tee '/usr/share/man/man1/linutil.1' > /dev/null
printf "%b\n" "${YELLOW}Creating a Desktop Entry...${RC}"
"$ESCALATION_TOOL" mkdir -p /usr/share/applications
curl 'https://raw.githubusercontent.com/ChrisTitusTech/linutil/refs/heads/main/linutil.desktop' | "$ESCALATION_TOOL" tee /usr/share/applications/linutil.desktop > /dev/null
printf "%b\n" "${GREEN}Done.${RC}"
}
checkEnv checkEnv
checkEscalationTool checkEscalationTool
checkAURHelper checkAURHelper

1
core/tabs/applications-setup/zsh-setup.sh
View File

@ -44,6 +44,7 @@ RPROMPT='%F{15}(%F{166}%D{%H:%M}%F{15})%f'
EOL EOL
# Ensure /etc/zsh/zshenv sets ZDOTDIR to the user's config directory # Ensure /etc/zsh/zshenv sets ZDOTDIR to the user's config directory
[ ! -f /etc/zsh/zshenv ] && "$ESCALATION_TOOL" mkdir -p /etc/zsh && "$ESCALATION_TOOL" touch /etc/zsh/zshenv
echo "export ZDOTDIR=\"$HOME/.config/zsh\"" | "$ESCALATION_TOOL" tee -a /etc/zsh/zshenv echo "export ZDOTDIR=\"$HOME/.config/zsh\"" | "$ESCALATION_TOOL" tee -a /etc/zsh/zshenv
} }

2
core/tabs/security/firewall-baselines.sh
View File

@ -30,7 +30,7 @@ configureUFW() {
printf "%b\n" "${YELLOW}Allowing port 80/tcp (UFW)${RC}" printf "%b\n" "${YELLOW}Allowing port 80/tcp (UFW)${RC}"
"$ESCALATION_TOOL" ufw allow 80/tcp "$ESCALATION_TOOL" ufw allow 80/tcp
printf "%b\n" "${YELLO}Allowing port 443/tcp (UFW)${RC}" printf "%b\n" "${YELLOW}Allowing port 443/tcp (UFW)${RC}"
"$ESCALATION_TOOL" ufw allow 443/tcp "$ESCALATION_TOOL" ufw allow 443/tcp
printf "%b\n" "${YELLOW}Denying Incoming Packets by Default(UFW)${RC}" printf "%b\n" "${YELLOW}Denying Incoming Packets by Default(UFW)${RC}"

10
core/tabs/system-setup/arch/server-setup.sh
View File

@ -216,7 +216,7 @@ echo -ne "
------------------------------------------------------------------------ ------------------------------------------------------------------------
THIS WILL FORMAT AND DELETE ALL DATA ON THE DISK THIS WILL FORMAT AND DELETE ALL DATA ON THE DISK
Please make sure you know what you are doing because Please make sure you know what you are doing because
after formating your disk there is no way to get data back after formatting your disk there is no way to get data back
*****BACKUP YOUR DATA BEFORE CONTINUING***** *****BACKUP YOUR DATA BEFORE CONTINUING*****
***I AM NOT RESPONSIBLE FOR ANY DATA LOSS*** ***I AM NOT RESPONSIBLE FOR ANY DATA LOSS***
------------------------------------------------------------------------ ------------------------------------------------------------------------
@ -328,7 +328,7 @@ echo -ne "
pacman -S --noconfirm --needed gptfdisk btrfs-progs glibc pacman -S --noconfirm --needed gptfdisk btrfs-progs glibc
echo -ne " echo -ne "
------------------------------------------------------------------------- -------------------------------------------------------------------------
Formating Disk Formatting Disk
------------------------------------------------------------------------- -------------------------------------------------------------------------
" "
umount -A --recursive /mnt # make sure everything is unmounted before we start umount -A --recursive /mnt # make sure everything is unmounted before we start
@ -466,7 +466,7 @@ if [[ $TOTAL_MEM -lt 8000000 ]]; then
mkswap /mnt/opt/swap/swapfile mkswap /mnt/opt/swap/swapfile
swapon /mnt/opt/swap/swapfile swapon /mnt/opt/swap/swapfile
# The line below is written to /mnt/ but doesn't contain /mnt/, since it's just / for the system itself. # The line below is written to /mnt/ but doesn't contain /mnt/, since it's just / for the system itself.
echo "/opt/swap/swapfile none swap sw 0 0" >> /mnt/etc/fstab # Add swap to fstab, so it KEEPS working after installation. echo "/opt/swap/swapfile none swap sw 0 0" >> /mnt/etc/fstab # Add swap to fstab, so it KEEPS working after installation.
fi fi
gpu_type=$(lspci | grep -E "VGA|3D|Display") gpu_type=$(lspci | grep -E "VGA|3D|Display")
@ -493,8 +493,8 @@ nc=$(grep -c ^processor /proc/cpuinfo)
echo -ne " echo -ne "
------------------------------------------------------------------------- -------------------------------------------------------------------------
You have " $nc" cores. And You have " $nc" cores. And
changing the makeflags for " $nc" cores. Aswell as changing the makeflags for " $nc" cores. Aswell as
changing the compression settings. changing the compression settings.
------------------------------------------------------------------------- -------------------------------------------------------------------------
" "
TOTAL_MEM=$(cat /proc/meminfo | grep -i 'memtotal' | grep -o '[[:digit:]]*') TOTAL_MEM=$(cat /proc/meminfo | grep -i 'memtotal' | grep -o '[[:digit:]]*')

10
core/tabs/system-setup/compile-setup.sh
View File

@ -15,30 +15,30 @@ installDepend() {
else else
printf "%b\n" "${GREEN}Multilib is already enabled.${RC}" printf "%b\n" "${GREEN}Multilib is already enabled.${RC}"
fi fi
"$AUR_HELPER" -S --needed --noconfirm "$DEPENDENCIES" "$AUR_HELPER" -S --needed --noconfirm $DEPENDENCIES
;; ;;
apt-get|nala) apt-get|nala)
COMPILEDEPS='build-essential' COMPILEDEPS='build-essential'
"$ESCALATION_TOOL" "$PACKAGER" update "$ESCALATION_TOOL" "$PACKAGER" update
"$ESCALATION_TOOL" dpkg --add-architecture i386 "$ESCALATION_TOOL" dpkg --add-architecture i386
"$ESCALATION_TOOL" "$PACKAGER" update "$ESCALATION_TOOL" "$PACKAGER" update
"$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES" "$COMPILEDEPS" "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES $COMPILEDEPS
;; ;;
dnf) dnf)
COMPILEDEPS='@development-tools' COMPILEDEPS='@development-tools'
"$ESCALATION_TOOL" "$PACKAGER" update "$ESCALATION_TOOL" "$PACKAGER" update
"$ESCALATION_TOOL" "$PACKAGER" config-manager --set-enabled powertools "$ESCALATION_TOOL" "$PACKAGER" config-manager --set-enabled powertools
"$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES" $COMPILEDEPS "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES $COMPILEDEPS
"$ESCALATION_TOOL" "$PACKAGER" install -y glibc-devel.i686 libgcc.i686 "$ESCALATION_TOOL" "$PACKAGER" install -y glibc-devel.i686 libgcc.i686
;; ;;
zypper) zypper)
COMPILEDEPS='patterns-devel-base-devel_basis' COMPILEDEPS='patterns-devel-base-devel_basis'
"$ESCALATION_TOOL" "$PACKAGER" refresh "$ESCALATION_TOOL" "$PACKAGER" refresh
"$ESCALATION_TOOL" "$PACKAGER" --non-interactive install "$DEPENDENCIES" "$COMPILEDEPS" "$ESCALATION_TOOL" "$PACKAGER" --non-interactive install $DEPENDENCIES $COMPILEDEPS
"$ESCALATION_TOOL" "$PACKAGER" --non-interactive install libgcc_s1-gcc7-32bit glibc-devel-32bit "$ESCALATION_TOOL" "$PACKAGER" --non-interactive install libgcc_s1-gcc7-32bit glibc-devel-32bit
;; ;;
*) *)
"$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES" "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES
;; ;;
esac esac
} }

2
core/tabs/system-setup/fedora/configure-dnf.sh
View File

@ -10,7 +10,7 @@ configureDNF() {
echo "fastestmirror=True" | "$ESCALATION_TOOL" tee -a /etc/dnf/dnf.conf > /dev/null echo "fastestmirror=True" | "$ESCALATION_TOOL" tee -a /etc/dnf/dnf.conf > /dev/null
echo "defaultyes=True" | "$ESCALATION_TOOL" tee -a /etc/dnf/dnf.conf > /dev/null echo "defaultyes=True" | "$ESCALATION_TOOL" tee -a /etc/dnf/dnf.conf > /dev/null
"$ESCALATION_TOOL" "$PACKAGER" -y install dnf-plugins-core "$ESCALATION_TOOL" "$PACKAGER" -y install dnf-plugins-core
printf "%b\n" "${GREEN}DNF Configured Succesfully...${RC}" printf "%b\n" "${GREEN}DNF Configured Successfully.${RC}"
;; ;;
*) *)
printf "%b\n" "${RED}Unsupported distribution: $DTYPE${RC}" printf "%b\n" "${RED}Unsupported distribution: $DTYPE${RC}"

2
core/tabs/system-setup/fedora/nvidia-proprietary-driver-setup.sh
View File

@ -3,7 +3,7 @@
. ../../common-script.sh . ../../common-script.sh
# This script allows user to download proprietary drivers for nvidia in fedora # This script allows user to download proprietary drivers for nvidia in fedora
# It also disables noveau nvidia drivers # It also disables nouveau nvidia drivers
# Installation guide link: https://rpmfusion.org/Howto/NVIDIA # Installation guide link: https://rpmfusion.org/Howto/NVIDIA

14
core/tabs/system-setup/gaming-setup.sh
View File

@ -23,7 +23,7 @@ installDepend() {
ncurses lib32-ncurses vulkan-icd-loader lib32-vulkan-icd-loader ocl-icd lib32-ocl-icd libva lib32-libva \ ncurses lib32-ncurses vulkan-icd-loader lib32-vulkan-icd-loader ocl-icd lib32-ocl-icd libva lib32-libva \
gst-plugins-base-libs lib32-gst-plugins-base-libs sdl2" gst-plugins-base-libs lib32-gst-plugins-base-libs sdl2"
$AUR_HELPER -S --needed --noconfirm "$DEPENDENCIES" "$DISTRO_DEPS" $AUR_HELPER -S --needed --noconfirm $DEPENDENCIES $DISTRO_DEPS
;; ;;
apt-get|nala) apt-get|nala)
DISTRO_DEPS="libasound2 libsdl2 wine64 wine32" DISTRO_DEPS="libasound2 libsdl2 wine64 wine32"
@ -33,24 +33,24 @@ installDepend() {
"$ESCALATION_TOOL" "$PACKAGER" install -y software-properties-common "$ESCALATION_TOOL" "$PACKAGER" install -y software-properties-common
"$ESCALATION_TOOL" apt-add-repository contrib -y "$ESCALATION_TOOL" apt-add-repository contrib -y
"$ESCALATION_TOOL" "$PACKAGER" update "$ESCALATION_TOOL" "$PACKAGER" update
"$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES" "$DISTRO_DEPS" "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES $DISTRO_DEPS
;; ;;
dnf) dnf)
if [ "$(rpm -E %fedora)" -le 41 ]; then if [ "$(rpm -E %fedora)" -le 41 ]; then
"$ESCALATION_TOOL" "$PACKAGER" install ffmpeg ffmpeg-libs -y "$ESCALATION_TOOL" "$PACKAGER" install ffmpeg ffmpeg-libs -y
"$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES" "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES
else else
printf "%b\n" "${CYAN}Fedora < 41 detected. Installing rpmfusion repos.${RC}" printf "%b\n" "${CYAN}Fedora < 41 detected. Installing rpmfusion repos.${RC}"
"$ESCALATION_TOOL" "$PACKAGER" install https://mirrors.rpmfusion.org/free/fedora/rpmfusion-free-release-"$(rpm -E %fedora)".noarch.rpm https://mirrors.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-"$(rpm -E %fedora)".noarch.rpm -y "$ESCALATION_TOOL" "$PACKAGER" install https://mirrors.rpmfusion.org/free/fedora/rpmfusion-free-release-"$(rpm -E %fedora)".noarch.rpm https://mirrors.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-"$(rpm -E %fedora)".noarch.rpm -y
"$ESCALATION_TOOL" "$PACKAGER" config-manager --enable fedora-cisco-openh264 -y "$ESCALATION_TOOL" "$PACKAGER" config-manager --enable fedora-cisco-openh264 -y
"$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES" "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES
fi fi
;; ;;
zypper) zypper)
"$ESCALATION_TOOL" "$PACKAGER" -n install "$DEPENDENCIES" "$ESCALATION_TOOL" "$PACKAGER" -n install $DEPENDENCIES
;; ;;
*) *)
"$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES" "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES
;; ;;
esac esac
} }
@ -59,7 +59,7 @@ installAdditionalDepend() {
case "$PACKAGER" in case "$PACKAGER" in
pacman) pacman)
DISTRO_DEPS='steam lutris goverlay' DISTRO_DEPS='steam lutris goverlay'
"$ESCALATION_TOOL" "$PACKAGER" -S --needed --noconfirm "$DISTRO_DEPS" "$ESCALATION_TOOL" "$PACKAGER" -S --needed --noconfirm $DISTRO_DEPS
;; ;;
apt-get|nala) apt-get|nala)
version=$(git -c 'versionsort.suffix=-' ls-remote --tags --sort='v:refname' https://github.com/lutris/lutris | version=$(git -c 'versionsort.suffix=-' ls-remote --tags --sort='v:refname' https://github.com/lutris/lutris |

44
core/tabs/system-setup/remove-snaps.sh
View File

@ -3,27 +3,29 @@
. ../common-script.sh . ../common-script.sh
removeSnaps() { removeSnaps() {
case "$PACKAGER" in if command_exists snap; then
pacman) case "$PACKAGER" in
"$ESCALATION_TOOL" "$PACKAGER" -Rns snapd pacman)
;; "$ESCALATION_TOOL" "$PACKAGER" -Rns snapd
apt-get|nala) ;;
"$ESCALATION_TOOL" "$PACKAGER" autoremove --purge snapd apt-get|nala)
if [ "$ID" = ubuntu ]; then "$ESCALATION_TOOL" "$PACKAGER" autoremove --purge snapd
"$ESCALATION_TOOL" apt-mark hold snapd if [ "$ID" = ubuntu ]; then
fi "$ESCALATION_TOOL" apt-mark hold snapd
;; fi
dnf) ;;
"$ESCALATION_TOOL" "$PACKAGER" remove snapd dnf|zypper)
;; "$ESCALATION_TOOL" "$PACKAGER" remove snapd
zypper) ;;
"$ESCALATION_TOOL" "$PACKAGER" remove snapd *)
;; printf "%b\n" "${RED}Unsupported package manager: ""$PACKAGER""${RC}"
*) exit 1
printf "%b\n" "${RED}Unsupported package manager: ""$PACKAGER""${RC}" ;;
exit 1 esac
;; printf "%b\n" "${GREEN}Successfully removed snaps.${RC}"
esac else
printf "%b\n" "${GREEN}Snapd is not installed.${RC}"
fi
} }
checkEnv checkEnv

25
core/tabs/system-setup/system-cleanup.sh Normal file → Executable file
View File

@ -23,19 +23,24 @@ cleanup_system() {
;; ;;
pacman) pacman)
"$ESCALATION_TOOL" "$PACKAGER" -Sc --noconfirm "$ESCALATION_TOOL" "$PACKAGER" -Sc --noconfirm
"$ESCALATION_TOOL" "$PACKAGER" -Rns "$(pacman -Qtdq)" --noconfirm "$ESCALATION_TOOL" "$PACKAGER" -Rns $(pacman -Qtdq) --noconfirm > /dev/null 2>&1
;; ;;
*) *)
printf "%b\n" "${RED}Unsupported package manager: ""$PACKAGER""${RC}" printf "%b\n" "${RED}Unsupported package manager: ${PACKAGER}. Skipping.${RC}"
return 1
;; ;;
esac esac
} }
common_cleanup() { common_cleanup() {
"$ESCALATION_TOOL" find /var/tmp -type f -atime +5 -delete if [ -d /var/tmp ]; then
"$ESCALATION_TOOL" find /tmp -type f -atime +5 -delete "$ESCALATION_TOOL" find /var/tmp -type f -atime +5 -delete
"$ESCALATION_TOOL" find /var/log -type f -name "*.log" -exec truncate -s 0 {} \; fi
if [ -d /tmp ]; then
"$ESCALATION_TOOL" find /tmp -type f -atime +5 -delete
fi
if [ -d /var/log ]; then
"$ESCALATION_TOOL" find /var/log -type f -name "*.log" -exec truncate -s 0 {} \;
fi
"$ESCALATION_TOOL" journalctl --vacuum-time=3d "$ESCALATION_TOOL" journalctl --vacuum-time=3d
} }
@ -45,8 +50,12 @@ clean_data() {
case $clean_response in case $clean_response in
y|Y) y|Y)
printf "%b\n" "${YELLOW}Cleaning up old cache files and emptying trash...${RC}" printf "%b\n" "${YELLOW}Cleaning up old cache files and emptying trash...${RC}"
find "$HOME/.cache/" -type f -atime +5 -delete if [ -d "$HOME/.cache" ]; then
find "$HOME/.local/share/Trash" -mindepth 1 -delete find "$HOME/.cache/" -type f -atime +5 -delete
fi
if [ -d "$HOME/.local/share/Trash" ]; then
find "$HOME/.local/share/Trash" -mindepth 1 -delete
fi
printf "%b\n" "${GREEN}Cache and trash cleanup completed.${RC}" printf "%b\n" "${GREEN}Cache and trash cleanup completed.${RC}"
;; ;;
*) *)

2
core/tabs/utils/monitor-control/change_orientation.sh
View File

@ -13,7 +13,7 @@ change_orientation() {
printf "%b\n" "${YELLOW}=========================================${RC}" printf "%b\n" "${YELLOW}=========================================${RC}"
printf "%b\n" "${YELLOW} Change Monitor Orientation${RC}" printf "%b\n" "${YELLOW} Change Monitor Orientation${RC}"
printf "%b\n" "${YELLOW}=========================================${RC}" printf "%b\n" "${YELLOW}=========================================${RC}"
printf "%b" "${YELLOW}Choose a monitor to configure: ${RC}" printf "%b\n" "${YELLOW}Choose a monitor to configure: ${RC}"
i=1 i=1
for monitor in $monitor_array; do for monitor in $monitor_array; do
printf "%b\n" "$i. ${GREEN}$monitor${RC}" printf "%b\n" "$i. ${GREEN}$monitor${RC}"

2
core/tabs/utils/monitor-control/disable_monitor.sh
View File

@ -13,7 +13,7 @@ disable_monitor() {
printf "%b\n" "${YELLOW}=========================================${RC}" printf "%b\n" "${YELLOW}=========================================${RC}"
printf "%b\n" "${YELLOW} Disable Monitor${RC}" printf "%b\n" "${YELLOW} Disable Monitor${RC}"
printf "%b\n" "${YELLOW}=========================================${RC}" printf "%b\n" "${YELLOW}=========================================${RC}"
printf "%b" "Choose a monitor to disable: " printf "%b\n" "Choose a monitor to disable: "
i=1 i=1
for monitor in $monitor_array; do for monitor in $monitor_array; do
printf "%b\n" "$i. ${GREEN}$monitor${RC}" printf "%b\n" "$i. ${GREEN}$monitor${RC}"

2
core/tabs/utils/monitor-control/enable_monitor.sh
View File

@ -13,7 +13,7 @@ enable_monitor() {
printf "%b\n" "${YELLOW}=========================================${RC}" printf "%b\n" "${YELLOW}=========================================${RC}"
printf "%b\n" "${YELLOW} Enable Monitor${RC}" printf "%b\n" "${YELLOW} Enable Monitor${RC}"
printf "%b\n" "${YELLOW}=========================================${RC}" printf "%b\n" "${YELLOW}=========================================${RC}"
printf "%b" "${YELLOW}Choose a monitor to enable: ${RC}" printf "%b\n" "${YELLOW}Choose a monitor to enable: ${RC}"
i=1 i=1
for monitor in $monitor_array; do for monitor in $monitor_array; do

2
core/tabs/utils/monitor-control/extend_displays.sh
View File

@ -1,6 +1,6 @@
#!/bin/sh -e #!/bin/sh -e
. ./utility_functions.sh . ../utility_functions.sh
. ../../common-script.sh . ../../common-script.sh

4
core/tabs/utils/monitor-control/manage_arrangement.sh
View File

@ -13,10 +13,10 @@ manage_arrangement() {
printf "%b\n" "${YELLOW}=========================================${RC}" printf "%b\n" "${YELLOW}=========================================${RC}"
printf "%b\n" "${YELLOW} Manage Monitor Arrangement${RC}" printf "%b\n" "${YELLOW} Manage Monitor Arrangement${RC}"
printf "%b\n" "${YELLOW}=========================================${RC}" printf "%b\n" "${YELLOW}=========================================${RC}"
printf "%b" "${YELLOW}Choose the monitor to arrange: ${RC}" printf "%b\n" "${YELLOW}Choose the monitor to arrange: ${RC}"
i=1 i=1
for monitor in $monitor_array; do for monitor in $monitor_array; do
printf "%b\n" "$i. ${YELLOW}$monitor${RC}" printf "%b\n" "$i. ${GREEN}$monitor${RC}"
i=$((i + 1)) i=$((i + 1))
done done

2
core/tabs/utils/monitor-control/set_primary_monitor.sh
View File

@ -16,7 +16,7 @@ set_primary_monitor() {
printf "%b\n" "${YELLOW}Choose a monitor to set as primary:${RC}" printf "%b\n" "${YELLOW}Choose a monitor to set as primary:${RC}"
i=1 i=1
for monitor in $monitor_array; do for monitor in $monitor_array; do
printf "%b\n" "$i. ${YELLOW}$monitor${RC}" printf "%b\n" "$i. ${GREEN}$monitor${RC}"
i=$((i + 1)) i=$((i + 1))
done done

26
core/tabs/utils/tab_data.toml
View File

@ -16,60 +16,66 @@ values = [":0", ":1", ":2", ":3", ":4", ":5", ":6", ":7", ":8", ":9"]
[[data.entries]] [[data.entries]]
name = "Auto Detect Displays" name = "Auto Detect Displays"
description = "This utility is designed to detect and apply recommended configuration for monitors connected with your system" description = "This script is designed to detect and apply recommended configuration for monitors connected with your system"
script = "monitor-control/auto_detect_displays.sh" script = "monitor-control/auto_detect_displays.sh"
[[data.entries]] [[data.entries]]
name = "Change Orientation" name = "Change Orientation"
description = "This utility is designed to change the orientation of monitors in your system" description = "This script is designed to change the orientation of monitors in your system"
script = "monitor-control/change_orientation.sh" script = "monitor-control/change_orientation.sh"
[[data.entries]] [[data.entries]]
name = "Disable Monitor" name = "Disable Monitor"
description = "This utility is designed to disable a monitor in your system" description = "This script is designed to disable a monitor in your system"
script = "monitor-control/disable_monitor.sh" script = "monitor-control/disable_monitor.sh"
[[data.entries]] [[data.entries]]
name = "Duplicate Displays" name = "Duplicate Displays"
description = "This utility is designed to duplicate display among multi-monitor setup in your system" description = "This script is designed to duplicate display among multi-monitor setup in your system"
script = "monitor-control/duplicate_displays.sh" script = "monitor-control/duplicate_displays.sh"
[[data.entries]] [[data.entries]]
name = "Enable Monitor" name = "Enable Monitor"
description = "This utility is designed to enable a monitor in your system" description = "This script is designed to enable a monitor in your system"
script = "monitor-control/enable_monitor.sh" script = "monitor-control/enable_monitor.sh"
[[data.entries]] [[data.entries]]
name = "Extend Displays" name = "Extend Displays"
description = "This utility is designed to extend display among multi-monitor setup in your system" description = "This script is designed to extend display among multi-monitor setup in your system"
script = "monitor-control/extend_displays.sh" script = "monitor-control/extend_displays.sh"
[[data.entries]] [[data.entries]]
name = "Manage Arrangement" name = "Manage Arrangement"
description = "This utility is designed to arrange monitors in multi-monitor setup in your system" description = "This script is designed to arrange monitors in multi-monitor setup in your system"
script = "monitor-control/manage_arrangement.sh" script = "monitor-control/manage_arrangement.sh"
[[data.entries]] [[data.entries]]
name = "Reset Scaling" name = "Reset Scaling"
description = "This utility is designed to reset scaling of a monitor in your system" description = "This script is designed to reset scaling of a monitor in your system"
script = "monitor-control/reset_scaling.sh" script = "monitor-control/reset_scaling.sh"
matches = true matches = true
[[data.entries]] [[data.entries]]
name = "Scale Monitors" name = "Scale Monitors"
description = "This utility is designed to change the scaling of monitors in your system" description = "This script is designed to change the scaling of monitors in your system"
script = "monitor-control/scale_monitor.sh" script = "monitor-control/scale_monitor.sh"
[[data.entries]] [[data.entries]]
name = "Set Brightness" name = "Set Brightness"
script = "monitor-control/set_brightness.sh" script = "monitor-control/set_brightness.sh"
description = "This script is designed to change the Brightness of monitors connected to your system"
matches = true matches = true
[[data.entries]] [[data.entries]]
name = "Set Primary Monitor" name = "Set Primary Monitor"
description = "This utility is designed to set a Primary monitor in your system" description = "This script is designed to set a Primary monitor in your system"
script = "monitor-control/set_primary_monitor.sh" script = "monitor-control/set_primary_monitor.sh"
[[data.entries]]
name = "Set Resolution"
description = "This script is designed to change the resolution of monitors connected to your system"
script = "monitor-control/set_resolutions.sh"
[[data]] [[data]]
name = "User Account Manager" name = "User Account Manager"

9
docs/assets/preview.tape
View File

@ -61,13 +61,14 @@ Require linutil
Require sh Require sh
Set Shell "bash" Set Shell "bash"
Set FontSize 32 Set FontFamily "JetBrainsMono Nerd Font"
Set Width 3200 Set FontSize 24
Set Height 1800 Set Width 1920
Set Height 1080
Sleep 1s Sleep 1s
Type "linutil -t compatible" Sleep 1s Enter Type "linutil" Sleep 1s Enter
Sleep 5s Sleep 5s

20
docs/contribute.md → docs/contributing.md
View File

@ -1,4 +1,6 @@
# How to Contribute? <!-- 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: 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:
@ -16,6 +18,7 @@ cd linutil
``` ```
## 3. Make your changes ## 3. Make your changes
- **Edit the files you want to change**: Make your changes to the relevant files. - **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. - **Test your changes**: Run `cargo run` to test your modifications in a local environment and ensure everything works as expected.
@ -40,22 +43,29 @@ cd linutil
- **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. - **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. - **Avoid combining unrelated changes**: PRs that tackle multiple unrelated issues are harder to review and might be rejected because of a single problem.
## 8. Code Review and Feedback ## 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. - **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. - **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.
## 9. Contributing Is More Than Just Code ## 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. - **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. - **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. - **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.
## 10. Documentation ## 11. Documentation
- **Update the documentation**: If your change affects the functionality, please update the relevant documentation files to reflect this. - **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`.
## 11. License ## 12. License
- **Agree to the license**: By contributing to Linutil, you agree that your contributions will be licensed under the project's MIT license. - **Agree to the license**: By contributing to Linutil, you agree that your contributions will be licensed under the project's MIT license.

198
docs/userguide.md
View File

@ -1,81 +1,151 @@
<!-- THIS FILE IS GENERATED BY cargo xtask docgen -->
# Walkthrough # Walkthrough
---
## System Setup
- **System Update**: Starts a system-wide update.
- **Compile Setup**: Installs tools and dependencies for compiling software.
- **Gaming Setup**: Configures Steam, Lutris, etc.
- **Global Theming**: Sets up and manages global themes.
- **Remove Snaps**: Removes snap packages.
- **TTY Fonts**: This Script will set the default TTY font to Terminus size 32 Bold
### Arch Setup
- **Paru Setup**: Installs the Paru AUR helper.
- **Yay Setup**: Installs the Yay AUR helper.
- **Server Setup**: Installs Arch Linux.
### Fedora Setup
- **RPM Fusion Setup**: Adds RPM Fusion free and nonfree repositories.
- **Multimedia Codecs**: Installs multimedia codecs and updates multimedia-related packages. Requires RPM Fusion repositories to be set up first.
- **NVIDIA Proprietary Driver Setup**: Installs proprietary NVIDIA drivers for GPUs from 2014 or later.
- **Virtualization Setup**: Installs virtualization tools.
- **Configure DNF**: Optimizes DNF for better speeds.
## Applications Setup ## Applications Setup
- **Flathub**: Installs Flatpak and Flathub.
- **Alacritty Setup**: Installs and configures Alacritty for you.
- **DwmTitus Setup**: Sets up the Dwm window manager.
- **Kitty Setup**: Installs and configures Kitty for you.
- **Rofi Setup**: Installs the Rofi application/script launcher.
- **Zsh Setup**: Installs and configures Zsh for you.
- **Fastfetch Setup**: Installs and configures Fastfetch.
- **Linutil Updater**: Updates the Linutil AUR / Crates.io Package.
- **Linutil Installer**: Installs Linutil via Crates.io or AUR.
- **Office Suite Setup**: Installs various office suites and PDF viewers (OnlyOffice, LibreOffice, WPS Office, FreeOffice, Evince, Okular, PDF Studio Viewer, PDF Studio).
### Developer Tools ### Developer Tools
- **Meld Setup**: Installs Meld, a visual diff and merge tool. - **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.
- **Ngrok Setup**: Installs Ngrok, a tool for creating secure tunnels to localhost. - **Neovim**: Neovim is a refactor, and sometimes redactor, in the tradition of Vim.
- **Neovim Setup**: Installs and configures Neovim, a Vim-based text editor. It is not a rewrite but a continuation and extension of Vim.
- **VS Code Setup**: Installs Visual Studio Code, a popular text editor. This command configures neovim from CTT's neovim configuration.
- **Sublime Setup**: Installs Sublime Text, a nice text editor for code and markup. https://github.com/ChrisTitusTech/neovim
- **VS Codium Setup**: Installs VS Codium, an open-source build of VS Code. - **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.
- **GitHub Desktop Setup**: Installs GitHub Desktop, a GUI for Git and GitHub. - **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.
- **Meld**: Meld is a visual diff and merge tool that helps compare files, directories, and version-controlled projects.
- **Ngrok**: Ngrok is a tool that creates secure, temporary tunnels to expose local servers to the internet for testing and development.
## Security Features ### Communication Apps
- **Firewall Baselines**: Sets up firewall rules. - **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.
- **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.
- **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.
### 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.
- **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 condifures 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.
- **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.
- **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.
- **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/
- **Virtualization**: Enables Virtualization through dnf
- **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 ## Utilities
- **Wifi Control**: Controls WiFi settings.
- **Numlock Control**: Sets up Numlock on boot.
- **Bluetooth Control**: Controls Bluetooth settings.
### Monitor control ### Monitor Control
- **Reset Scaling**: Resets monitor scaling to native resolution. - **Auto Detect Displays**: This script is designed to detect and apply recommended configuration for monitors connected with your system
- **Scale Monitor**: Scales smaller monitors to the highest resolution of a bigger monitor. - **Change Orientation**: This script is designed to change the orientation of monitors in your system
- **Enable Monitor**: Enables a selected monitor. - **Disable Monitor**: This script is designed to disable a monitor in your system
- **Disable Monitor**: Disables a selected monitor. - **Duplicate Displays**: This script is designed to duplicate display among multi-monitor setup in your system
- **Set Brightness**: Adjusts brightness for a selected monitor. - **Enable Monitor**: This script is designed to enable a monitor in your system
- **Set Resolutions**: Sets resolutions for connected monitors. - **Extend Displays**: This script is designed to extend display among multi-monitor setup in your system
- **Change Orientation**: Changes the orientation of a selected monitor. - **Manage Arrangement**: This script is designed to arrange monitors in multi-monitor setup in your system
- **Extend Displays**: Extends displays to the right. - **Reset Scaling**: This script is designed to reset scaling of a monitor in your system
- **Duplicate Displays**: Duplicates displays. - **Scale Monitors**: This script is designed to change the scaling of monitors in your system
- **Manage Arrangement**: Manages the arrangement of multiple monitors. - **Set Brightness**: This script is designed to change the Brightness of monitors connected to your system
- **Set Primary Monitor**: Sets a selected monitor as the main display. - **Set Primary Monitor**: This script is designed to set a Primary monitor in your system
- **Auto Detect Displays**: Sets common resolution. - **Set Resolution**: This script is designed to change the resolution of monitors connected to your system
### User Account Manager ### User Account Manager
- **Add User**: Creates a new user account. - **Auto Mount Drive**: This utility is designed to help with automating the process of mounting a drive on to your system.
- **Delete User**: Deletes an existing user account. - **Bluetooth Manager**: This utility is designed to manage bluetooth in your system
- **Add to Group**: Adds a user to specified groups. - **Numlock on Startup**: This utility is designed to configure auto enabling of numlock on boot
- **Remove from Group**: Removes a user from specified groups. - **Ollama**: This utility is designed to manage ollama in your system
- **Change Password**: Changes the password for a user account. - **Service Manager**: This utility is designed to manage services in your system
- **WiFi Manager**: This utility is designed to manage wifi in your system

3
linutil.desktop
View File

@ -1,6 +1,7 @@
[Desktop Entry] [Desktop Entry]
Name=Linutil Name=Linutil
Exec=sh -c "$HOME/.local/bin/linutil" Comment=Distro-agnostic toolbox designed to simplify everyday Linux tasks
Exec=sh -c '/usr/bin/linutil || $HOME/.cargo/bin/linutil || linutil'
Icon=utilities-terminal Icon=utilities-terminal
Type=Application Type=Application
Terminal=true Terminal=true

65
man/linutil.1 Normal file
View File

@ -0,0 +1,65 @@
.\" manpage for Linutil
.TH "linutil" "1" "October 2024" "" "Linutil Manual"
.SH NAME
linutil \- Chris Titus Tech's Linux Toolbox
.SH SYNOPSIS
\fBlinutil [OPTIONS]\fR
.SH DESCRIPTION
Linutil is a distro-agnostic toolbox designed to simplify everyday Linux tasks.
.br
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.
.SH LIVE VERSION
To get started with the live version, pick which branch you would like to use, then run the command in your terminal:
.TP
\fBStable Branch\fR
curl -fsSL https://christitus.com/linux | sh
.TP
\fBDevelopement branch\fR
curl -fsSL https://christitus.com/linuxdev | sh
.SH OPTIONS
.TP
\fB\-t\fR, \fB\-\-theme\fR \fI<theme>\fR
Set the theme to use in the TUI.
.br
Possible values:
\fIdefault\fR,
\fIcompatible\fR.
.br
Defaults to \fIdefault\fR.
.TP
\fB\-\-override\-validation\fR
Show all available entries, disregarding compatibility checks. (\fBUNSAFE\fR)
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help.
.SH SUPPORT
If you find Linutil helpful, please consider giving it a star on GitHub to show your support!
https://github.com/ChrisTitusTech/linutil
.SH DOCUMENTATION
For comprehensive information on how to use Linutil, visit the Official Linutil Documentation.
https://christitustech.github.io/linutil
.SH AUTHOR
Written by Adam Perkowski.
<adas1per@protonmail.com>
.SH REPORTING BUGS
Since the project is still in active development, you may encounter some issues.
.br
Please consider submitting feedback if you do.
https://github.com/ChrisTitusTech/linutil/issues
.SH COPYRIGHT
Copyright (c) 2024 Chris Titus.
.br
MIT License.
https://opensource.org/license/MIT

4
start.sh
View File

@ -14,8 +14,8 @@ check() {
exit 1 exit 1
fi fi
unset exit_code unset exit_code
unset message unset message
} }
findArch() { findArch() {

6
tui/Cargo.toml
View File

@ -7,7 +7,7 @@ edition = "2021"
license.workspace = true license.workspace = true
repository = "https://github.com/ChrisTitusTech/linutil/tree/main/tui" repository = "https://github.com/ChrisTitusTech/linutil/tree/main/tui"
version.workspace = true version.workspace = true
include = ["src/*.rs", "Cargo.toml", "build.rs", "cool_tips.txt"] include = ["src/*.rs", "Cargo.toml", "build.rs", "cool_tips.txt", "../man/linutil.1"]
build = "build.rs" build = "build.rs"
[features] [features]
@ -15,7 +15,7 @@ default = ["tips"]
tips = ["rand"] tips = ["rand"]
[dependencies] [dependencies]
clap = { version = "4.5.18", features = ["derive"] } clap = { version = "4.5.19", features = ["derive"] }
crossterm = "0.28.1" crossterm = "0.28.1"
ego-tree = { workspace = true } ego-tree = { workspace = true }
oneshot = "0.1.8" oneshot = "0.1.8"
@ -25,7 +25,7 @@ tui-term = "0.1.12"
unicode-width = "0.2.0" unicode-width = "0.2.0"
rand = { version = "0.8.5", optional = true } rand = { version = "0.8.5", optional = true }
linutil_core = { path = "../core", version = "24.9.28" } linutil_core = { path = "../core", version = "24.9.28" }
tree-sitter-highlight = "0.23.0" tree-sitter-highlight = "0.24.2"
tree-sitter-bash = "0.23.1" tree-sitter-bash = "0.23.1"
anstyle = "1.0.8" anstyle = "1.0.8"
ansi-to-tui = "6.0.0" ansi-to-tui = "6.0.0"

18
tui/src/filter.rs
View File

@ -1,5 +1,5 @@
use crate::{state::ListEntry, theme::Theme}; use crate::{state::ListEntry, theme::Theme};
use crossterm::event::{KeyCode, KeyEvent}; use crossterm::event::{KeyCode, KeyEvent, KeyModifiers};
use ego_tree::NodeId; use ego_tree::NodeId;
use linutil_core::Tab; use linutil_core::Tab;
use ratatui::{ use ratatui::{
@ -116,21 +116,27 @@ impl Filter {
pub fn handle_key(&mut self, event: &KeyEvent) -> SearchAction { pub fn handle_key(&mut self, event: &KeyEvent) -> SearchAction {
//Insert user input into the search bar //Insert user input into the search bar
match event.code { match event.code {
KeyCode::Char('c') if event.modifiers.contains(KeyModifiers::CONTROL) => {
return self.exit_search()
}
KeyCode::Char(c) => self.insert_char(c), KeyCode::Char(c) => self.insert_char(c),
KeyCode::Backspace => self.remove_previous(), KeyCode::Backspace => self.remove_previous(),
KeyCode::Delete => self.remove_next(), KeyCode::Delete => self.remove_next(),
KeyCode::Left => return self.cursor_left(), KeyCode::Left => return self.cursor_left(),
KeyCode::Right => return self.cursor_right(), KeyCode::Right => return self.cursor_right(),
KeyCode::Esc => {
self.input_position = 0;
self.search_input.clear();
return SearchAction::Exit;
}
KeyCode::Enter => return SearchAction::Exit, KeyCode::Enter => return SearchAction::Exit,
KeyCode::Esc => return self.exit_search(),
_ => return SearchAction::None, _ => return SearchAction::None,
}; };
SearchAction::Update SearchAction::Update
} }
fn exit_search(&mut self) -> SearchAction {
self.input_position = 0;
self.search_input.clear();
SearchAction::Exit
}
fn cursor_left(&mut self) -> SearchAction { fn cursor_left(&mut self) -> SearchAction {
self.input_position = self.input_position.saturating_sub(1); self.input_position = self.input_position.saturating_sub(1);
SearchAction::None SearchAction::None

28
tui/src/floating_text.rs
View File

@ -24,18 +24,12 @@ use tree_sitter_bash as hl_bash;
use tree_sitter_highlight::{self as hl, HighlightEvent}; use tree_sitter_highlight::{self as hl, HighlightEvent};
use zips::zip_result; use zips::zip_result;
pub enum FloatingTextMode {
Preview,
Description,
ActionsGuide,
}
pub struct FloatingText { pub struct FloatingText {
pub src: Vec<String>, pub src: Vec<String>,
max_line_width: usize, max_line_width: usize,
v_scroll: usize, v_scroll: usize,
h_scroll: usize, h_scroll: usize,
mode_title: &'static str, mode_title: String,
} }
macro_rules! style { macro_rules! style {
@ -130,7 +124,7 @@ fn get_lines_owned(s: &str) -> Vec<String> {
} }
impl FloatingText { impl FloatingText {
pub fn new(text: String, mode: FloatingTextMode) -> Self { pub fn new(text: String, title: &str) -> Self {
let src = get_lines(&text) let src = get_lines(&text)
.into_iter() .into_iter()
.map(|s| s.to_string()) .map(|s| s.to_string())
@ -139,14 +133,14 @@ impl FloatingText {
let max_line_width = max_width!(src); let max_line_width = max_width!(src);
Self { Self {
src, src,
mode_title: Self::get_mode_title(mode), mode_title: title.to_string(),
max_line_width, max_line_width,
v_scroll: 0, v_scroll: 0,
h_scroll: 0, h_scroll: 0,
} }
} }
pub fn from_command(command: &Command, mode: FloatingTextMode) -> Option<Self> { pub fn from_command(command: &Command, title: String) -> Option<Self> {
let (max_line_width, src) = match command { let (max_line_width, src) = match command {
Command::Raw(cmd) => { Command::Raw(cmd) => {
// just apply highlights directly // just apply highlights directly
@ -169,21 +163,13 @@ impl FloatingText {
Some(Self { Some(Self {
src, src,
mode_title: Self::get_mode_title(mode), mode_title: title,
max_line_width, max_line_width,
h_scroll: 0, h_scroll: 0,
v_scroll: 0, v_scroll: 0,
}) })
} }
fn get_mode_title(mode: FloatingTextMode) -> &'static str {
match mode {
FloatingTextMode::Preview => "Command Preview",
FloatingTextMode::Description => "Command Description",
FloatingTextMode::ActionsGuide => "Important Actions Guide",
}
}
fn scroll_down(&mut self) { fn scroll_down(&mut self) {
if self.v_scroll + 1 < self.src.len() { if self.v_scroll + 1 < self.src.len() {
self.v_scroll += 1; self.v_scroll += 1;
@ -214,7 +200,7 @@ impl FloatContent for FloatingText {
// Define the Block with a border and background color // Define the Block with a border and background color
let block = Block::default() let block = Block::default()
.borders(Borders::ALL) .borders(Borders::ALL)
.title(self.mode_title) .title(self.mode_title.clone())
.title_alignment(ratatui::layout::Alignment::Center) .title_alignment(ratatui::layout::Alignment::Center)
.title_style(Style::default().reversed()) .title_style(Style::default().reversed())
.style(Style::default()); .style(Style::default());
@ -292,7 +278,7 @@ impl FloatContent for FloatingText {
fn get_shortcut_list(&self) -> (&str, Box<[Shortcut]>) { fn get_shortcut_list(&self) -> (&str, Box<[Shortcut]>) {
( (
self.mode_title, &self.mode_title,
Box::new([ Box::new([
Shortcut::new("Scroll down", ["j", "Down"]), Shortcut::new("Scroll down", ["j", "Down"]),
Shortcut::new("Scroll up", ["k", "Up"]), Shortcut::new("Scroll up", ["k", "Up"]),

24
tui/src/state.rs
View File

@ -1,10 +1,8 @@
use std::rc::Rc;
use crate::{ use crate::{
confirmation::{ConfirmPrompt, ConfirmStatus}, confirmation::{ConfirmPrompt, ConfirmStatus},
filter::{Filter, SearchAction}, filter::{Filter, SearchAction},
float::{Float, FloatContent}, float::{Float, FloatContent},
floating_text::{FloatingText, FloatingTextMode}, floating_text::FloatingText,
hint::{create_shortcut_list, Shortcut}, hint::{create_shortcut_list, Shortcut},
running_command::RunningCommand, running_command::RunningCommand,
theme::Theme, theme::Theme,
@ -21,6 +19,7 @@ use ratatui::{
widgets::{Block, Borders, List, ListState, Paragraph}, widgets::{Block, Borders, List, ListState, Paragraph},
Frame, Frame,
}; };
use std::rc::Rc;
const MIN_WIDTH: u16 = 77; const MIN_WIDTH: u16 = 77;
const MIN_HEIGHT: u16 = 19; const MIN_HEIGHT: u16 = 19;
@ -51,7 +50,7 @@ pub struct AppState {
/// This stack keeps track of our "current directory". You can think of it as `pwd`. but not /// This stack keeps track of our "current directory". You can think of it as `pwd`. but not
/// just the current directory, all paths that took us here, so we can "cd .." /// just the current directory, all paths that took us here, so we can "cd .."
visit_stack: Vec<NodeId>, visit_stack: Vec<NodeId>,
/// This is the state asociated with the list widget, used to display the selection in the /// This is the state associated with the list widget, used to display the selection in the
/// widget /// widget
selection: ListState, selection: ListState,
filter: Filter, filter: Filter,
@ -116,7 +115,10 @@ impl AppState {
match self.focus { match self.focus {
Focus::Search => ( Focus::Search => (
"Search bar", "Search bar",
Box::new([Shortcut::new("Finish search", ["Enter"])]), Box::new([
Shortcut::new("Abort search", ["Esc", "CTRL-c"]),
Shortcut::new("Search", ["Enter"]),
]),
), ),
Focus::List => { Focus::List => {
@ -651,10 +653,10 @@ impl AppState {
} }
fn enable_preview(&mut self) { fn enable_preview(&mut self) {
if let Some(node) = self.get_selected_node() { if let Some(list_node) = self.get_selected_node() {
if let Some(preview) = let mut preview_title = "[Preview] - ".to_string();
FloatingText::from_command(&node.command, FloatingTextMode::Preview) preview_title.push_str(list_node.name.as_str());
{ if let Some(preview) = FloatingText::from_command(&list_node.command, preview_title) {
self.spawn_float(preview, 80, 80); self.spawn_float(preview, 80, 80);
} }
} }
@ -662,7 +664,7 @@ impl AppState {
fn enable_description(&mut self) { fn enable_description(&mut self) {
if let Some(command_description) = self.get_selected_description() { if let Some(command_description) = self.get_selected_description() {
let description = FloatingText::new(command_description, FloatingTextMode::Description); let description = FloatingText::new(command_description, "Command Description");
self.spawn_float(description, 80, 80); self.spawn_float(description, 80, 80);
} }
} }
@ -728,7 +730,7 @@ impl AppState {
fn toggle_task_list_guide(&mut self) { fn toggle_task_list_guide(&mut self) {
self.spawn_float( self.spawn_float(
FloatingText::new(ACTIONS_GUIDE.to_string(), FloatingTextMode::ActionsGuide), FloatingText::new(ACTIONS_GUIDE.to_string(), "Important Actions Guide"),
80, 80,
80, 80,
); );

8
xtask/Cargo.toml Normal file
View File

@ -0,0 +1,8 @@
[package]
name = "xtask"
version.workspace = true
license.workspace = true
edition.workspace = true
[dependencies]
linutil_core = { path = "../core" }

60
xtask/src/docgen.rs Normal file
View File

@ -0,0 +1,60 @@
use std::fs;
use linutil_core::Command;
use crate::path;
use crate::DynError;
pub const USER_GUIDE: &str = "userguide.md";
pub fn userguide() -> Result<String, DynError> {
let mut md = String::new();
md.push_str("<!-- THIS FILE IS GENERATED BY cargo xtask docgen -->\n# Walkthrough\n");
let tabs = linutil_core::get_tabs(false).1;
for tab in tabs {
#[cfg(debug_assertions)]
println!("Tab: {}", tab.name);
md.push_str(&format!("\n## {}\n\n", tab.name));
for entry in tab.tree {
if entry.command == Command::None {
#[cfg(debug_assertions)]
println!(" Directory: {}", entry.name);
if entry.name != "root".to_string() {
md.push_str(&format!("\n### {}\n\n", entry.name));
}
/* let current_dir = &entry.name;
if *current_dir != "root".to_string() {
md.push_str(&format!(
"\n<details><summary>{}</summary>\n\n",
current_dir
));
} */ // Commenting this for now, might be a good idea later
} else {
if !entry.description.is_empty() {
#[cfg(debug_assertions)]
println!(" Entry: {}", entry.name);
#[cfg(debug_assertions)]
println!(" Description: {}", entry.description);
md.push_str(&format!("- **{}**: {}\n", entry.name, entry.description));
} /* else {
md.push_str(&format!("- **{}**\n", entry.name));
} */ // https://github.com/ChrisTitusTech/linutil/pull/753
}
}
}
Ok(md)
}
pub fn write(file: &str, data: &str) {
let path = path::docs().join(file);
fs::write(path, data).unwrap_or_else(|_| panic!("Could not write to {}", file));
}

40
xtask/src/main.rs Normal file
View File

@ -0,0 +1,40 @@
mod docgen;
mod path;
use std::{env, error::Error};
type DynError = Box<dyn Error>;
pub mod tasks {
use crate::docgen::USER_GUIDE;
use crate::docgen::{userguide, write};
use crate::DynError;
pub fn docgen() -> Result<(), DynError> {
write(USER_GUIDE, &userguide()?);
Ok(())
}
pub fn print_help() {
println!(
"
Usage: `cargo xtask <task>`
Tasks:
docgen: Generate Markdown files.
"
);
}
}
fn main() -> Result<(), DynError> {
let task = env::args().nth(1);
match task {
None => tasks::print_help(),
Some(t) => match t.as_str() {
"docgen" => tasks::docgen()?,
invalid => return Err(format!("Invalid task: {}", invalid).into()),
},
};
Ok(())
}

12
xtask/src/path.rs Normal file
View File

@ -0,0 +1,12 @@
use std::path::{Path, PathBuf};
pub fn project_root() -> PathBuf {
Path::new(env!("CARGO_MANIFEST_DIR"))
.parent()
.unwrap()
.to_path_buf()
}
pub fn docs() -> PathBuf {
project_root().join("docs/")
}