Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pforret/shaml

Read YAML files inside bash scripts
https://github.com/pforret/shaml

bash bashew yaml

Last synced: about 1 month ago
JSON representation

Read YAML files inside bash scripts

Host: GitHub
URL: https://github.com/pforret/shaml
Owner: pforret
License: mit
Created: 2024-03-03T12:34:40.000Z (12 months ago)
Default Branch: master
Last Pushed: 2024-03-03T16:04:06.000Z (12 months ago)
Last Synced: 2024-11-14T06:36:21.683Z (3 months ago)
Topics: bash, bashew, yaml
Language: Shell
Homepage:
Size: 975 KB
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        ![bash_unit CI](https://github.com/pforret/shaml/workflows/bash_unit%20CI/badge.svg)

![Shellcheck CI](https://github.com/pforret/shaml/workflows/Shellcheck%20CI/badge.svg)

![GH Language](https://img.shields.io/github/languages/top/pforret/shaml)

![GH stars](https://img.shields.io/github/stars/pforret/shaml)

![GH tag](https://img.shields.io/github/v/tag/pforret/shaml)

![GH License](https://img.shields.io/github/license/pforret/shaml)

[![basher install](https://img.shields.io/badge/basher-install-white?logo=gnu-bash&style=flat)](https://www.basher.it/package/)

# shaml

![shaml](assets/url.download.215333.jpg)

Read YAML files within bash

## 🔥 Usage

```

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 ] [-t ] [-P ]    

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

             : [choice] action to perform  [options: all,find,check,env,update]

              : [parameter] input file (optional)

                : [parameter] key to find (for shaml find) (optional)

            : [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

```

## ⚡️ Examples

### `shaml all`

Input:

```yaml

# 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:

```bash

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")

```

### `shaml find`

```bash

Sentence="$(shaml find input.yaml Sentence)"

# Sentence="one sentence"

```

```bash

Optional="$(shaml find input.yaml Optional "This is the default")"

# Optional="This is the default"

```

## 🚀 Installation

with [basher](https://github.com/basherpm/basher)

	$ basher install pforret/shaml

or with `git`

	$ git clone https://github.com/pforret/shaml.git

	$ cd shaml

## 📝 Acknowledgements

* script created with [bashew](https://github.com/pforret/bashew)

© 2024 Peter Forret