Skip to content

bash-sdk πŸ”₯ ​

A bash library to create standalone scripts.

Features ✨ ​

There are some features of bash-sdk are mentioned here.

  • OOPS like code πŸ’Ž.
  • Module based code πŸ—‚οΈ.
  • Similar functions to python 🐍.
  • Standalone script creation πŸ“”.

Beauty 🏡️ ​

Checkout the ui of this cli project here.

General 🍷 ​

There are some rules or things to keep in mind while using this library.

The rules are mentioned here.

Installation πŸŒ€ ​

Just clone it to anywhere.

sh
git clone --depth=1 https://github.com/OurCodeBase/bash-sdk.git

Modules πŸ“š ​

These are the modules created in bash-sdk library. You can read about their functions by clicking on them.

Structure πŸ—ƒοΈ ​

File structure of bash-sdk is like:

sh
bash-sdk
β”œβ”€β”€ docs # docs for bash-sdk.
β”œβ”€β”€ _uri.sh # helper of builder.
β”œβ”€β”€ builder.sh
└── src
    β”œβ”€β”€ ask.sh
    β”œβ”€β”€ cursor.sh
    β”œβ”€β”€ db.sh
    β”œβ”€β”€ file.sh
    β”œβ”€β”€ inspect.sh
    β”œβ”€β”€ os.sh
    β”œβ”€β”€ package.sh
    β”œβ”€β”€ repo.sh
    β”œβ”€β”€ say.sh
    β”œβ”€β”€ screen.sh
    β”œβ”€β”€ spinner.sh
    β”œβ”€β”€ string.sh
    └── url.sh

Compiler 🧭 ​

Compiler does combine all codes in a standalone bash file.

sh
bash builder.sh -i "path/to/input.sh" -o "path/to/output.sh";
  • input file is the file that you are going to compile.
  • output file is the standalone result file.

Then you can directly execute output file without bash-sdk library.

Queries πŸ“’ ​

If you have any questions or doubt related to this library you can directly ask everything here.

Suggestion πŸ‘Œ ​

Author πŸ¦‹ ​