cb

A CLI for Crunchy Bridge with very good tab completion.

Installation

• For homebrew (on macOS or linux) brew install will/cb/cb. This will install both cb and the shell tab completions for you.
• For others, download the latest release, put it somewhere in your path, and be sure to manually install shell tab completions from the completions directory.

Usage

To see what commands are available run cb --help, and to see more detailed information for a given command add --help to it, for example cb create --help.

Development

Install dependencies: crystal

You can run quick checks by executing src/cli.cr directly. While this can be handy, it is slow because the executable is being built each time, then executed. To build a development version run make or shards build. The binary will be at bin/cb by default. There is a helper script dev_setup.fish which puts the local bin directory in your path so the cb in that directory will be ran, as well as an scb alias for running src/cli.cr. It will also set up completions for each.

crystal tool --format will format the code as required. It is useful to have your editor run this for you on save.

testing

You can run crystal spec to run all of the specs, or make test to also run linting checks.

Contributing

1. Fork it (https://github.com/will/cb/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Include an entry in the changelog
6. Create a new Pull Request