LinuxShss

Collection of Linux shell utilities

Index

Description [↑]

This is a collection of Linux shell utilities with each focusing on one specific task, thus following the Unix philosophy of simplicity.

Features [↑]

The collection features:

• Locrel script to check if a list of AUR packages and GitHub repositories have new versions
• Bootrep script to print a variety of information about the current boot
• Pacup script as a Pacman -Syu wrapper to nicely prompt to update

Screenshots [↑]

Installation [↑]

Arch Linux

You can install LinuxShss from the AUR repository:

• For information on how to install an AUR package read this wiki.

Then you should ensure the shell you use has ~/.local/bin added to the PATH env.

[!NOTE] Only users created after installation will have the scripts in ~/.local/bin as explained in the manual installation instructions.

Manually

The LinuxShss installation is really straightforward.

Check you have the required dependencies. Copy the files located in the ./bin/ directory of the repository to /etc/skel/.local/bin and/or ~/.local/bin to install globally or on a per-user basis. When installed globally, every user created after the installation will receive a copy of the scripts in ~/.local/bin except if the system has a different skel directory configured or does not copy the skel directory on user creation. After installing the scripts ensure the shell you use has ~/.local/bin added to the PATH env as to be able to directly run the scripts without having to be on the installation directory.

[!NOTE] Even though the scripts can be installed to a global location like /usr/bin it is preffered to install them to the user path ~/.local/bin as they are meant to be easyly customizable and some perform user-specific actions.

Updating [↑]

When updating LinuxShss just follow the steps for installation.

[!WARNING] Any custom changes to the scripts will dissapear. If you wish those changes persist simply add them to the new scripts.

Dependencies [↑]

Buildtime

The LinuxShss project has no buildtime dependencies.

Runtime

Every scripts depends on bash as they are bash scripts.

• Locrel script also depends on jq for parsing JSON, curl for pulling web data and awk for modifying origins file. Errors will be issued if the dependencies are not found!
• Bootrep optionally depends on some system configuration to work and will print some errors if the system does not use what it expects to use. In such case, simply delete the lines that print those errors as they target a different system configuration. If the user is knowledgeable in their system configuration they can usually replace them to work for their system.
• Pacup depends on pacman as it is fundamentally just a simple wrapper for prompting if the user wants to update, with a default value of no.

Configuration [↑]

The only script which actually has configuration is Locrel which has a $origins variable at the start of the file that contains the path of the origins file.

Discussions [↑]

Feel free to give any ideas for future scripts here and ask any questions you have here.

Contributions [↑]

All contributions are welcome! The steps involved when making a contribution are explained in the CONTRIBUTING.md file. We look forward to your contributions!

• The contributors list is located here.

Documentation [↑]

• Locrel:

  • Configure the $origins variable in the script to point to a valid origins file
  • Populate the origins file following the format:
  • <provider> <identifier> <latest_version> (<branch>)
  • Where
    • <provider>: ( 'aur' | 'github' | 'github-commit' )
    • <identifier>: ( aur -> package-name | ( github | github-commit ) -> user/repo )
    • <latest_version>: ((aur | github) -> latest-version | github-commit -> hash )
    • <branch>: ( ( aur | github ) -> not-allowed | github-commit -> branch ) [Default: master]
  • Examples
    • aur shikai-theme v1.5.3-1
    • github TheWisker/Shikai v1.5.3
    • github-commit TheWisker/Shikai 33220107395cfbddede8b6a679269ec71fd9bb75 master
  • Simply run the locrel script

• Bootrep:

  • Make any desired changes like adding or removing output instructions
  • Simply run the bootrep script

• Pacup:

  • Simply run the pacup script

License [↑]

This project is licensed under the GNU GENERAL PUBLIC LICENSE v3.

Code of Conduct [↑]

This project follows the Contributor Covenant Code of Conduct.

Author [↑]

TheWisker