-
-
Notifications
You must be signed in to change notification settings - Fork 1
What is cbf?
cbf 🦥 is a bit meta 🤦♂️. It's basically a CLI for CLIs. It allows you to define a CLI with a yml or json file. Then you can save that in your project's repo or just run it in your daily activities.
I love working in the terminal and I love CLIs. So I write a lot of them and it gets tiring. So I decided to make a tool that would make it easier and I figured it'd be nice to have a generic format for a CLI I could commit to my projects repositories
cbf is a tool that runs cbf scripts. cbf scripts are yml or json files that define the behavior a CLI.
cbf scripts can be simple or advanced.
Simple scripts are made up of options and commands.
- The first tag is required and is the scripts name
- options are stored as keys
- commands are stored as values
Advanced scripts are made up of option's, command's, variables, message's and directory's
- The first tag is required and is the scripts name
-
optiontags are used to store lists of moreoptionsorcommand's -
commandtags are used to store one or many strings containing shell commands -
variablestags are used to prompt the user for variables to be replaced in a command -
messagetags are used to store messages that are printed to stdout when an option or command is selected -
directorytags are used to set where a command should be run. When a command is run, CBF recursively searches for the commands set directory or closest set parentdirectorytag
Thanks for using cbf 🦥