Introduction

The command line interface (CLI) is the main way to interact with Blockwork. It adopts a style similar to git with stacked sub-commands and scoped options. It may be invoked using the blockwork command, or by using the short-hand version of just bw.

Top-Level Options

• --help - displays the built-in help, listing the top-level options and the first level of subcommands;

• --cwd <DIR> / -C <DIR> - by default Blockwork will expect the current working directory or one of its parents to contain a .bw.yaml configuration file, if commands are being run from outside of this hierarchy then the working directory can be overridden using this option.

Commands

• bootstrap - runs all known bootstrapping stages;
• exec - executes a command within the contained environment;
• info - displays information about the current project;
• shell - opens a shell within the contained environment;
• tool - invoke a specific action of a selected tool;
• tools - lists all available tools.

Usage Example

$> bw --help
Usage: bw [OPTIONS] COMMAND [ARGS]...

Options:
  -C, --cwd DIRECTORY  Override the working directory
  --help               Show this message and exit.

Commands:
  info   List information about the project
  shell
  tools  Tabulate all of the available tools