Giter Club home page Giter Club logo

bash-functions's Introduction

Bash Functions Collection

Efficiently automate your daily tasks with our versatile collection of Bash functions, all easily accessible with the bash-functions-autoloader.

Author

Marius Guščius

Getting Started

Prerequisites

  • Bash shell
  • Git

Installation

  1. Clone this repository (including all submodules) into your desired directory within your home (${HOME}) directory.

    git clone --recurse-submodules [email protected]:masterjg/bash-functions.git ${HOME}/bash-functions
  2. Add the autoloader script to your shell rc file (.bashrc, .bash_profile, etc.):

    echo 'source ${HOME}/bash-functions/init.sh' >> ${HOME}/.bashrc
  3. Reload your shell configuration:

    source ${HOME}/.bashrc

Usage

After installation, the bash functions from this collection are automatically loaded and can be used in your shell.

Contributing

We welcome contributions, especially for adding support for new operating systems. To contribute, follow these steps:

  1. Under the functions folder, create a tree structure for the OS you want to support. For example, for Fedora Kinoite version 39, create: bash-functions/functions/fedora/kinoite/39. The path should follow this format: functions/$(ID=fedora)/$(VARIANT_ID=kinoite)/$(VERSION_ID=39).

  2. Inside the newly created folder, create a symlink to the autoloader script:

    ln -s ../../../../autoloader/__loader.sh __loader.sh

    Your directory structure should look like this:

    /functions/fedora/kinoite/39
    ├── ...
    └── __loader.sh -> ../../../../autoloader/__loader.sh
    
  3. Start adding directories and .sh files that will be autoloaded. For more information, refer to the bash-functions-autoloader README.

License

This project is licensed under the GNU Affero General Public License (AGPL). For more details, see the LICENSE file.

bash-functions's People

Contributors

masterjg avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.