Rargs 🚀

Introducing Rargs, a Bash framework incorporating elements from Bashly and Argc for high-efficiency script deployment.

Features
Installation
Usage
Examples
API Reference
Contributing
License

Features 🌟

Good help messages.
Good argument, flag, and option parsing.
Good handling of environment variables.
Good handling of script dependencies.
Good suport for script sub-commands.
Inline documentation.

Installation 🛠️

The best way to install rargs is to download the pre-built version from the project Release page.

Build from source

You can build your own version of rargs using cargo, Rust build tool. To do so, clone the project into a directory, change into the cloned directory and run cargo.

git clone https://github.com/cloudbridgeuy/rargs.git
cd rargs
cargo build --bin rargs

You can find the build binary in the created target/release dirctory by the name rargs. Copy it into a directory on your path, or add the release directory you your PATH, and give the rargs binary executable permissions.

chmod +x rargs

Usage 💻

Here is a quick example:

rargc -- build -d ./bin ./src/script.sh

Command Line Arguments

A bash framework for managing your bash scripts

Usage: rargs [COMMAND]

Commands:
  run    Runs a rargs script
  build  Build the script
  help   Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

Examples 💡

Example use-cases can be found under the /crates/rargs/examples directory.

API Reference 📖

Documentation can be found here.

Contributing ❤️

See CONTRIBUTING.md for ways to get started.

License 📜

This project is licensed under the MIT License - see the LICENSE.md file for details.

Made with ❤️ by @cloudbridgeuy

cloudbridgeuy/rargs