Skip to content

How to use cbf?

Joshua Vernon edited this page Jan 3, 2020 · 2 revisions

Set up

Installation
npm i cbf -g

or

yarn global add cbf

Usage

λ cbf -h

Usage: cbf [options]

cbf is a simple CLI tool for developers who can't be f#@!'d learning or remembering commands.

Go to https://github.com/joshuatvernon/cbf to learn how to make cbf scripts.

Options:
  -V, --version                     output the version number
  -D, --delete [script name]        delete a previously saved script
  -A, --delete-all                  delete all previously saved scripts
  -d, --documented                  prepends the command to the questions when running a script
  -R, --dry-run                     prints the command that would have been run to stdout
  -j, --json                        run scripts in a package json file
  -l, --list                        list previously saved scripts
  -p, --print [script name]         print a saved script
  -r, --run [script name]           run a previously saved script
  -s, --save <path to script file>  process and save a script from a yaml or json file
  -S, --shell                       set which shell commands should be run within
  -h, --help                        output usage information

Scripts

  • How to write a simple cbf script
  • How to write an advanced cbf script

Usage ideas

  • Commit a cbf.yml file to your repo with commands to set up and/or run your project (get rid of your README.md 😋)
  • Run commands within the scripts section of your projects package.json file without adding any new files to your project
  • Add all the commands you run every day to a cbf script and never have to remember them again

Check out cbf's 🦥 site to get started!

Clone this wiki locally