https://github.com/jiab77/bash-funcs

Just a basic collection of Bash Functions that can be used in any scripts.
https://github.com/jiab77/bash-funcs

bash functions

Last synced: 2 days ago
JSON representation

Just a basic collection of Bash Functions that can be used in any scripts.

• Host: GitHub
• URL: https://github.com/jiab77/bash-funcs
• Owner: Jiab77
• License: mit
• Created: 2024-04-06T21:38:26.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2025-01-06T01:43:16.000Z (3 days ago)
• Last Synced: 2025-01-06T02:39:22.736Z (3 days ago)
• Topics: bash, functions
• Language: Shell
• Homepage:
• Size: 41 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bash Funcs

Just a basic collection of Bash Functions that can be used in any scripts.

> This project is still experimental and should be used with caution.

## How to use

There are several ways to use this project and some of them will be described below.

### In scripts

Add the following line in your scripts:

```bash

[[ -r /path/to/bash_funcs ]] && source /path/to/bash_funcs

```

### In your current Bash session

Just run the following command:

```console

$ source /path/to/bash_funcs

```

### In all your Bash sessions

Edit your `~/.bashrc` file and add the following lines:

```bash

# Load 'bash-funcs' project

[[ -r /path/to/bash_funcs ]] && source /path/to/bash_funcs

[[ -n show_self_loading ]] && show_self_loading 2>/dev/null

```

Once done, you can call any included functions.

### In ZSH instead of Bash

You can call any included functions from your ZSH shell as long as `bash-funcs` has been added to your `~/.bashrc` files as explained above.

Here is how to do:

```console

$ bash -i -c ' [args]'

```

Example:

```console

$ bash -i -c 'show_device_temp'

Loaded 'bash_funcs' file

 - From: /path/to/bash-funcs

 - Version: 0.6.0

acpitz - 59°C - all good

pch_skylake - 81°C - critical

x86_pkg_temp - 62°C - getting hot

```

## Arguments

Even if this file __MUST__ be sourced to be used, it support the following arguments:

```console

$ bash /path/to/bash_funcs -h

Usage: bash_funcs [flags] -- Collection of Bash functions

Flags:

  -h | --help		Print this message and exit

  -l | --list		Print list of included functions and exit

  -v | --version	Print file version and exit

```

> Note that there is a check included in the file that will be triggered if the 'exec' permission is being granted.

## Thanks

Huge thanks to the work made by the THC group for the inspiration.

## Author

* __Jiab77__