Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/DannyBen/bashly

Bash command line framework and CLI generator
https://github.com/DannyBen/bashly

bash bash-scripting cli cli-framework cli-generator code-generator ruby

Last synced: about 1 month ago
JSON representation

Bash command line framework and CLI generator

Host: GitHub
URL: https://github.com/DannyBen/bashly
Owner: DannyBen
License: mit
Created: 2019-11-19T19:52:16.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-10-28T14:44:31.000Z (about 2 months ago)
Last Synced: 2024-10-28T17:27:48.061Z (about 2 months ago)
Topics: bash, bash-scripting, cli, cli-framework, cli-generator, code-generator, ruby
Language: Ruby
Homepage: https://bashly.dannyb.co
Size: 3.15 MB
Stars: 2,099
Watchers: 15
Forks: 87
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Support: support/demo/.gitignore

Awesome Lists containing this project

awesome-bash - bashly - Bash command line framework and CLI generator. (Libraries / Reusable Things)
awesome-cli-frameworks - Bashly - rich bash command line tools. Bashly lets you focus on your specific code, without worrying about command line argument parsing, usage texts, error messages and other functions that are usually handled by a framework in any other programming language. (Bash/Shell)
Open-Source-Ruby-and-Rails-Apps - bashly - Bash command line framework and CLI generator 🔥 (Happy Exploring 🤘)
awesome-hacking-lists - DannyBen/bashly - Bash command line framework and CLI generator (Ruby)
awesome-starred - DannyBen/bashly - Bash command line framework and CLI generator (ruby)

README

        




# Bashly - Bash CLI Framework and Generator

Create feature-rich bash scripts using simple YAML configuration

[![Gem Version](https://badge.fury.io/rb/bashly.svg)](https://badge.fury.io/rb/bashly)

[![Build Status](https://github.com/DannyBen/bashly/workflows/Test/badge.svg)](https://github.com/DannyBen/bashly/actions?query=workflow%3ATest)

[![Maintainability](https://api.codeclimate.com/v1/badges/8cf89047e50ca601e431/maintainability)](https://codeclimate.com/github/DannyBen/bashly/maintainability)

## [bashly.dannyb.co](https://bashly.dannyb.co)

---

![demo](support/demo/cast.gif)



Bashly is a command line application (written in Ruby) that lets you

generate feature-rich bash command line tools.

Bashly lets you focus on your specific code, without worrying about command line

argument parsing, usage texts, error messages and other functions that are

usually handled by a framework in any other programming language.

It is available both as a [ruby gem](https://rubygems.org/gems/bashly) and as

a [docker image](https://hub.docker.com/r/dannyben/bashly).

## Documentation

- [Bashly Homepage][docs]

- [Examples][examples]

## How it works

1. You provide a YAML configuration file, describing commands, sub-commands,

   arguments, and flags. Running `bashly init` creates an initial sample YAML

   file for you ([example](https://github.com/DannyBen/bashly/tree/master/examples/minimal#bashlyyml)).

2. Bashly then automatically generates a bash script (when you run

   `bashly generate`) that can parse and validate user input, provide help

   messages, and run your code for each command.

3. Your code for each command is kept in a separate file, and can be merged

   again if you change it ([example](https://github.com/DannyBen/bashly/blob/master/examples/minimal/src/root_command.sh)).

## Features

Bashly is responsible for:

- Generating a **single, standalone bash script**.

- Generating a **human readable, shellcheck-compliant and shfmt-compliant script**.

- Generating **usage texts** and help screens, showing your tool's arguments, flags and commands (works for sub-commands also).

- Parsing the user's command line and extracting:

  - Optional or required **positional arguments**.

  - Optional or required **option flags** (with or without flag arguments).

  - **Commands** (and sub-commands).

  - Standard flags (like **--help** and **--version**).

- Preventing your script from running unless the command line is valid.

- Providing you with a place to input your code for each of the functions your tool performs, and merging it back to the final script.

- Providing you with additional (optional) framework-style, standard library functions:

  - **Color output**.

  - **Config file management** (INI format).

  - **YAML parsing**.

  - **Bash completions**.

  - *and more*.

- Auto-generating **markdown and man page documentation** for your script.

## Contributing / Support

If you experience any issue, have a question or a suggestion, or if you wish

to contribute, feel free to [open an issue][issues] or

[start a discussion][discussions].

Visit the *[How to contribute][contributing]* page for more information.

[issues]: https://github.com/DannyBen/bashly/issues

[discussions]: https://github.com/DannyBen/bashly/discussions

[docs]: https://bashly.dannyb.co/

[examples]: https://github.com/DannyBen/bashly/tree/master/examples#bashly-examples

[contributing]: https://github.com/DannyBen/bashly/blob/master/CONTRIBUTING.md#how-to-contribute