https://github.com/chemaclass/bash-skeleton

A skeleton to build your bash cli-app.
https://github.com/chemaclass/bash-skeleton

bash cli-app skeleton-application

Last synced: 8 days ago
JSON representation

A skeleton to build your bash cli-app.

• Host: GitHub
• URL: https://github.com/chemaclass/bash-skeleton
• Owner: Chemaclass
• License: mit
• Created: 2024-09-15T16:51:56.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-10-05T22:15:15.000Z (about 1 month ago)
• Last Synced: 2024-11-08T07:05:33.823Z (8 days ago)
• Topics: bash, cli-app, skeleton-application
• Language: Shell
• Homepage: https://chemaclass.com/
• Size: 38.1 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# bash-skeleton

This skeleton provides a strong yet simple foundation, making it easy to start building robust Bash scripts with a

well-structured architecture.

## Features

- **Dependency Management**: Uses [bashdep](https://github.com/Chemaclass/bashdep) for managing dependencies.

    - Install with: `install-dependencies.sh`

- **Testing**: Integrates [bashunit](https://github.com/TypedDevs/bashunit/) for testing.

    - Tests in: `tests/`

- **Source Structure**: Organize functions in different files.

    - Source in: `src/`

- **Entry Point**: Ready to handle arguments and options.

    - Script: `./entry-point`

- **Build System**: Bundle your project into a single executable.

    - Use: `./build.sh`

- **CI**: Automates linting, static analysis, and tests on commits/PRs.

    - Workflows in: `.github/workflows/`

- **Pre-commit Hook**: Optional hook for running tests, linter, and analysis.

    - Script: `bin/pre-commit`

- **Makefile**: Simplifies project management with basic commands.

    - Available in: `Makefile`

## Inspired by

This skeleton is the result of building other projects like:

- bashunit: https://github.com/TypedDevs/bashunit

- create-pr: https://github.com/Chemaclass/create-pr

- bashdep: https://github.com/Chemaclass/bashdep

- release: https://github.com/Purpose-Green/release

## Contribute

Suggestions, ideas and PRs are more than welcome here!

Please, Check out our [CONTRIBUTING.md](.github/CONTRIBUTING.md) guidelines.