Read YAML files within bash
Program : shaml by [email protected]
Version : v0.1.0 (Mar 3 16:48:21 2024)
Purpose : Read YAML files within bash
Usage : shaml [-h] [-q] [-v] [-f] [-l <log_dir>] [-t <tmp_dir>] [-P <PREFIX>] <action> <input?> <key?> <default?>
Flags, options and parameters:
-h|--help : [flag] show usage [default: off]
-q|--quiet : [flag] no output [default: off]
-v|--verbose : [flag] also show debug messages [default: off]
-f|--force : [flag] do not ask for confirmation (always yes) [default: off]
-l|--log_dir <?> : [option] folder for log files [default: /$HOME/log/shaml]
-t|--tmp_dir <?> : [option] folder for temp files [default: /tmp/shaml]
-P|--PREFIX <?> : [option] variable prefix
<action> : [choice] action to perform [options: all,find,check,env,update]
<input> : [parameter] input file (optional)
<key> : [parameter] key to find (for shaml find) (optional)
<default> : [parameter] default value (for shaml find) (optional)
### TIPS & EXAMPLES
* use shaml all to convert YAML file to level1_level2_key=value lines
shaml all
* use shaml find to find the value of 1 YAML key in a file
shaml find key default
* use shaml check to check if this script is ready to execute and what values the options/flags are
shaml check
* use shaml env to generate an example .env file
shaml env > .env
* use shaml update to update to the latest version
shaml update
* >>> bash script created with pforret/bashew
* >>> for bash development, also check out pforret/setver and pforret/progressbar
Input:
# comment start on col 1
Word: one # comment starts after
Sentence: "one sentence"
level1:
level2:
level3:
level4:
level5:
level6: "sixth level"
Months:
- January
- February
- March
Author:
Name: "John Doe"
Address: "123 Main St, Anytown, USA"
Tags:
Hobbies:
- "Fishing"
- "Waterpolo"shaml all input.yaml will output:
Word="one"
Sentence="one sentence"
level1_level2_level3_level4_level5_level6="sixth level"
Months =("January")
Months =("February")
Months =("March")
Author_Name="John Doe"
Author_Address="123 Main St, Anytown, USA"
Author_Tags_Hobbies =("Fishing")
Author_Tags_Hobbies =("Waterpolo")Sentence="$(shaml find input.yaml Sentence)"
# Sentence="one sentence"Optional="$(shaml find input.yaml Optional "This is the default")"
# Optional="This is the default"with basher
$ basher install pforret/shaml
or with git
$ git clone https://github.com/pforret/shaml.git
$ cd shaml
- script created with bashew
© 2024 Peter Forret