bluer-options 5.213.1

🌀 Options for Bash.

🌀 bluer-options

🌀 bluer_options implements an options argument for Bash.

installation

pip install bluer_options

if using outside the bluer-ai ecosystem, add this line to ~/.bash_profile or ~/.bashrc,

source $(python3 -m bluer_options locate)/.bash/bluer_options.sh

for more refer to 🔻 giza.

usage

let the function receive one or more options arguments (example below) then parse them with bluer_ai_option, bluer_ai_option_int, and bluer_ai_option_choice.

function func() {
    local options=$1

    local var=$(bluer_ai_option "$options" var default)
    local key=$(bluer_ai_option_int "$options" key 0)
    local choice=$(bluer_ai_option_choice "$options" value_1,value_2,value_3 default)

    :
}

this enables the user to call func as,

func var=12,~key,value_1

all options have defaults and order doesn't matter.

example 1

here is an example use of an options in the vancouver-watching 🌈 ingest command:

 > @help vanwatch ingest

vanwatch \
	ingest \
	[area=<area>,count=<-1>,~download,dryrun,~upload] \
	[-|<object-name>] \
	[process,count=<-1>,~download,dryrun,gif,model=<model-id>,publish,~upload] \
	[--detect_objects 0] \
	[--overwrite 1] \
	[--verbose 1]

this command takes in an options, an object, and args. an options is a string representation of a dictionary, such as,

area=<vancouver>,~batch,count=<-1>,dryrun,gif,model=<model-id>,~process,publish,~upload

which is equivalent, in json notation, to,

{
    "area": "vancouver",
    "batch": false,
    "count": -1,
    "dryrun": true,
    "gif": true,
    "model": "<model-id>",
    "process": false,
    "publish": true,
    "upload": false,
}

example 2

from reddit

How can I automate these tree commands I frequently need to type out? I would like to run:

git add .
git commit -m "Initial "commit"
git push

I got bored of typing them out each time. Can I make an alias or something like "gc" (for git commit). The commit message is always the same "Initial commit".

first, install bluer-options. this will also install blueness.

pip install bluer_options

then, copy example1.sh to your machine and add this line to the end of your bash_profile,

source <path/to/example1.sh>

now, you have access to the @git super command. here is how it works.

1. @git help shows usage instructions (see below).
2. @git commit runs the three commands. you can customize the message by running @git commit <message>. you can also avoid the push by running @git commit <message> ~push.
3. for any <task> other than commit, @git <task> <args> runs git <task> <args>.

 > @git help
 @git commit [<message>] \
	~push
 . git commit with <message> and push.
@git <command>
 . git <command>.

---

🌀 blue-options for the Global South.

---

built by 🌀 blueness-3.118.1.