https://github.com/flarebyte/baldrick-broth
Build automation tool and task runner
https://github.com/flarebyte/baldrick-broth
build-tool npm-cli
Last synced: 8 months ago
JSON representation
Build automation tool and task runner
- Host: GitHub
- URL: https://github.com/flarebyte/baldrick-broth
- Owner: flarebyte
- License: mit
- Created: 2022-07-22T08:07:40.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-09-21T16:22:36.000Z (8 months ago)
- Last Synced: 2025-09-21T16:30:06.173Z (8 months ago)
- Topics: build-tool, npm-cli
- Language: TypeScript
- Homepage:
- Size: 5.46 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# baldrick-broth
 
> Build automation tool and task runner
Take your developer workflow to the next level with a custom CLI with
relevant documentation for running your task
Highlights:
- Automate tasks such as testing, scaffolding, minification, and
compilation of code.
- Reduce the amount of time needed to set up new projects
- YAML configuration with json-schema allowing code assistance in the
editor (eg. visual studio code).
- Provide clear documentation for each step of a project build
- Ensure that documentation is always up-to-date and available in the CLI
- Run certain tasks only if certain conditions are met
- Allow developers to define their own model for their project
- Provide an easy way for developers to provide interactive input when
running a task
## Documentation and links
- [Code Maintenance :wrench:](MAINTENANCE.md)
- [Code Of Conduct](CODE_OF_CONDUCT.md)
- [Api for baldrick-broth](API.md)
- [Contributing :busts\_in\_silhouette: :construction:](CONTRIBUTING.md)
- [Diagram for the code base :triangular\_ruler:](INTERNAL.md)
- [Vocabulary used in the code base :book:](CODE_VOCABULARY.md)
- [Architectural Decision Records :memo:](DECISIONS.md)
- [Contributors
:busts\_in\_silhouette:](https://github.com/flarebyte/baldrick-broth/graphs/contributors)
- [Dependencies](https://github.com/flarebyte/baldrick-broth/network/dependencies)
- [Glossary
:book:](https://github.com/flarebyte/overview/blob/main/GLOSSARY.md)
- [Software engineering principles
:gem:](https://github.com/flarebyte/overview/blob/main/PRINCIPLES.md)
- [Overview of Flarebyte.com ecosystem
:factory:](https://github.com/flarebyte/overview)
- [Usage](USAGE.md)
- [Overview for the json schema for broth yaml file](SCHEMA.md)
- [Json schema for broth yaml
file](spec/snapshots/build-model/get-schema--schema.json)
- [Code Analysis](CODE_ANALYSIS.md)
- [Agent Notes](AGENTS_PROJECT.md)
## Related
- [baldrick-zest-engine](https://github.com/flarebyte/baldrick-zest-engine)
Run tests declaratively with a few cunning plans
## Installation
This package is [ESM
only](https://blog.sindresorhus.com/get-ready-for-esm-aa53530b3f77).
```bash
yarn global add baldrick-broth
baldrick-broth --help
```
Or alternatively run it:
```bash
npx baldrick-broth --help
```
If you want to tun the latest version from github. Mostly useful for dev:
```bash
git clone git@github.com:flarebyte/baldrick-broth.git
yarn global add `pwd`
```