cmd

Documentation

Overview

Package cmd implements wr's command line interface.

It is implemented using cobra, so see github.com/spf13/cobra for details. On top of cobra we use our own config system; see internal/config.go.

cmd/root.go contains general utility functions for use by any of the sub command implementations. It also give the help text you see when you run `wr` by itself.

Each wr sub-command (eg. 'add' or 'manager') is implemented in its own .go file.

Index

• Variables
• func Execute()

Variables

var RootCmd = &cobra.Command{
	Use:   "wr",
	Short: "wr is a software workflow management system.",
	Long: `wr is a software workflow management system and command runner.

You use it to run the same sequence of commands (a "workflow") on many different
input files (which comprise a "datasource").

Initially, you start the management system, which maintains a queue of the
commands you want to run:
$ wr manager start

Then you either directly add commands you want to run to the queue:
$ wr add

Or you define a workflow that works out the commands for you:
Create a workflow with:                           $ wr create
Define a datasource with:                         $ wr datasource
Set up an instance of workflow + datasource with: $ wr setup
[create, datasource and setup commands are not yet implemented; just use add for
now]

At this point your commands should be running, and you can monitor their
progress with:
$ wr status

Finally, you can find your output files with:
$ wr outputs`,
}

RootCmd represents the base command when called without any subcommands.

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.