bashbud works like a static site generator (hugo,jekyll,etc.), generating documents based on templates with content written in markdown.
bashbud was created to organize and structure bash script projects, but it can be used to generate any type of document, and be used for other programming (or non-programming) projects.
It is written in gawk and bash. bashbud itself is used to generate the documentation.
If you are using Arch linux, you can install the bashbud package from AUR.
Or follow the instructions below to install from source:
git clone https://github.com/budlabs/bashbud.git
cd bashbud
sudo make install
bashbud --new|-n [GENERATOR] **TARGET_DIR**
bashbud --bump|-b [PROJECT_DIR]
bashbud --link|-l [PROJECT_DIR]
bashbud --get|-g KEY [PROJECT_DIR]
bashbud --set|-s KEY VALUE [PROJECT_DIR]
bashbud --help|-h
bashbud --version|-v
bashbud can be used to quickly create new scripts with
cli-option support and automatic documentation applied.
--new|-n
Creates a new project at TARGET_DIR (if TARGET_DIR doesnt
exist, if it does script will exit), based on GENERATOR. If
GENERATOR is omitted the default generator will be used.
After all files are copied and linked, the project is
bumped (same as: bashbud --bump TARGET_DIR).
--bump|-b
The current working direcory will be set as PROJECT_DIR if
none is specified. When a project is bumped, bashbud
will read the manifest.md file in PROJECT_DIR, (or exit
if no manifest.md file exists). If a generator type is
specified in the front matter (the YAML section
starting the document) of the manifest.md file, that
generator will be used to update the project based on the
content of the manifest.md file and the manifest.d
directory (if it exists). If a directory named bashbud
exists within PROJECT_DIR, that directory will be used as
a generator.
--link|-l
Add any missing links from the generators __link
directory, to PROJECT_DIR.
--get|-g KEY
Get the value from a key in the YAML frontmatter of the
manifest.md. If last argument is a directory, the manifest
in that directory will be used, otherwise the current
directory is assumed.
--set|-s VALUE
Set the value of KEY in the YAML frontmatter of the
manifest.md to VALUE. If last argument is a directory, the
manifest in that directory will be used, otherwise the
current directory is assumed.
--help|-h
Show help and exit.
--version|-v
Show version and exit.
See the bashbud wiki or the manpage bashbud(1) for a
detailed description on how bashbud works and what it
can do.
2019-02-02
New feature, bump script directories, read more in the
wiki:
https://github.com/budlabs/bashbud/wiki/05CA_bump_scripts
Fixed an issue where link definitions in markdown got interpreted as paragraphs resulting in an embarrassing parsing error in the main readme of this repo.
2019-01-01
Lots of improvements bug fixes. Two new command line
options (--get and --set) to get/set values from the
YAML of a projects manifest.md.
2019-01-01
First public release, read the wiki, report the issues,
stay calm and keep kyle.
bashbud is licensed with the MIT license