Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vroncevic/gen_sh_mod
Generate shell module script for sh_util
https://github.com/vroncevic/gen_sh_mod
bash bsd development freebsd generator linux macos module modules qnx shell unix
Last synced: 22 days ago
JSON representation
Generate shell module script for sh_util
- Host: GitHub
- URL: https://github.com/vroncevic/gen_sh_mod
- Owner: vroncevic
- License: gpl-3.0
- Created: 2017-01-25T21:13:30.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-14T18:41:50.000Z (5 months ago)
- Last Synced: 2024-06-14T19:53:09.846Z (5 months ago)
- Topics: bash, bsd, development, freebsd, generator, linux, macos, module, modules, qnx, shell, unix
- Language: Shell
- Homepage: https://vroncevic.github.io/gen_sh_mod
- Size: 6.81 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Generate shell module script for sh_util
**gen_sh_mod** is shell tool for generating shell module.
Developed in **[bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell))** code: **100%**.
[](https://github.com/vroncevic/gen_sh_mod/actions/workflows/gen_sh_mod_shell_checker.yml)
The README is used to introduce the modules and provide instructions on
how to install the modules, any machine dependencies it may have and any
other information that should be provided before the modules are installed.
[](https://github.com/vroncevic/gen_sh_mod/issues) [](https://github.com/vroncevic/gen_sh_mod/graphs/contributors)
**Table of Contents**
- [Installation](#installation)
- [Usage](#usage)
- [Dependencies](#dependencies)
- [Shell tool structure](#shell-tool-structure)
- [Docs](#docs)
- [Copyright and licence](#copyright-and-licence)
### Installation
Navigate to release **[page](https://github.com/vroncevic/gen_sh_mod/releases)** download and extract release archive.
To install **gen_sh_mod** type the following
```bash
tar xvzf gen_sh_mod-x.y.tar.gz
cd gen_sh_mod-x.y
cp -R ~/sh_tool/bin/ /root/scripts/gen_sh_mod/ver.x.y/
cp -R ~/sh_tool/conf/ /root/scripts/gen_sh_mod/ver.x.y/
cp -R ~/sh_tool/log/ /root/scripts/gen_sh_mod/ver.x.y/
```
Self generated setup script and execution
```bash
./gen_sh_mod_setup.sh
[setup] installing App/Tool/Script gen_sh_mod
Wed 01 Dec 2021 11:43:15 PM CET
[setup] copy App/Tool/Script structure
[setup] remove github editor configuration files
[setup] set App/Tool/Script permission
[setup] create symbolic link of App/Tool/Script
[setup] done
/root/scripts/gen_sh_mod/ver.2.0/
├── bin/
│ ├── center.sh
│ ├── display_logo.sh
│ └── gen_sh_mod.sh
├── conf/
│ ├── gen_sh_mod.cfg
│ ├── gen_sh_mod.logo
│ ├── gen_sh_mod_util.cfg
│ └── template/
│ └── module.template
└── log/
└── gen_sh_mod.log
4 directories, 8 files
lrwxrwxrwx 1 root root 50 Dec 1 23:43 /root/bin/gen_sh_mod -> /root/scripts/gen_sh_mod/ver.2.0/bin/gen_sh_mod.sh
```
Or You can use docker to create image/container.
### Usage
```bash
# Create symlink for shell tool
ln -s /root/scripts/gen_sh_mod/ver.x.y/bin/gen_sh_mod.sh /root/bin/gen_sh_mod
# Setting PATH
export PATH=${PATH}:/root/bin/
# Generating shell module
gen_sh_mod FileCheck
gen_sh_mod ver.2.0
Wed 01 Dec 2021 11:45:12 PM CET
[check_root] Check permission for current session? [ok]
[check_root] Done
██ ██
░██ ░██
█████ █████ ███████ ██████░██ ██████████ ██████ ░██
██░░░██ ██░░░██░░██░░░██ ██░░░░ ░██████ ░░██░░██░░██ ██░░░░██ ██████
░██ ░██░███████ ░██ ░██ ░░█████ ░██░░░██ ░██ ░██ ░██░██ ░██ ██░░░██
░░██████░██░░░░ ░██ ░██ ░░░░░██░██ ░██ ░██ ░██ ░██░██ ░██░██ ░██
░░░░░██░░██████ ███ ░██ █████ ██████ ░██ ░██ █████ ███ ░██ ░██░░██████ ░░██████
█████ ░░░░░░ ░░░ ░░ ░░░░░ ░░░░░░ ░░ ░░ ░░░░░ ░░░ ░░ ░░ ░░░░░░ ░░░░░░
░░░░░
Info github.io/gen_sh_mod ver.2.0
Issue github.io/issue
Author vroncevic.github.io
[gen_sh_mod] Loading basic and util configuration!
100% [================================================]
[load_conf] Loading App/Tool/Script configuration!
[check_cfg] Checking configuration file [/root/scripts/gen_sh_mod/ver.2.0/conf/gen_sh_mod.cfg] [ok]
[check_cfg] Done
[load_conf] Done
[load_util_conf] Load module configuration!
[check_cfg] Checking configuration file [/root/scripts/gen_sh_mod/ver.2.0/conf/gen_sh_mod_util.cfg] [ok]
[check_cfg] Done
[load_util_conf] Done
[gen_sh_mod] Generating file [FileCheck.sh]
[gen_sh_mod] Set owner!
[gen_sh_mod] Set permission!
[logging] Checking directory [/root/scripts/gen_sh_mod/ver.2.0/log/]? [ok]
[logging] Write info log!
[logging] Done
[gen_sh_mod] Done
[check_tool] Checking tool [/usr/bin/tree]? [ok]
[check_tool] Done
```
### Dependencies
**gen_sh_mod** requires next modules and libraries
* sh_util [https://github.com/vroncevic/sh_util](https://github.com/vroncevic/sh_util)
### Shell tool structure
**gen_sh_mod** is based on MOP.
Shell tool structure
```bash
sh_tool/
├── bin/
│ ├── center.sh
│ ├── display_logo.sh
│ └── gen_sh_mod.sh
├── conf/
│ ├── gen_sh_mod.cfg
│ ├── gen_sh_mod.logo
│ ├── gen_sh_mod_util.cfg
│ └── template/
│ └── module.template
└── log/
└── gen_sh_mod.log
```
### Docs
[](https://gen-sh-mod.readthedocs.io/projects/gen_sh_mod/en/latest/?badge=latest)
More documentation and info at
* [https://gen_sh_mod.readthedocs.io/en/latest/](https://gen-sh-mod.readthedocs.io/en/latest/)
* [https://www.gnu.org/software/bash/manual/](https://www.gnu.org/software/bash/manual/)
### Copyright and licence
[](https://www.gnu.org/licenses/gpl-3.0) [](https://opensource.org/licenses/Apache-2.0)
Copyright (C) 2017 - 2024 by [vroncevic.github.io/gen_sh_mod](https://vroncevic.github.io/gen_sh_mod)
**gen_sh_mod** is free software; you can redistribute it and/or modify
it under the same terms as Bash itself, either Bash version 4.2.47 or,
at your option, any later version of Bash 4 you may have available.
Lets help and support FSF.
[](https://my.fsf.org/)
[](https://my.fsf.org/donate/)