CLI usage

You can either run a task or provide an --option.

dotnet do <task>
dotnet do <option>

Task

dotnet do <task>

This is how you will use DotNet Do the majority of the time. In place of <task>, specify the name of the task available at the current directory to run it. For example, to run a task named my-task execute:

dotnet do my-task

To see what tasks are available to you at any time use the --list option.

Options

Help

dotnet do --help dotnet do -h dotnet do -?

This will provide you with the semantic version of DotNet Do and a brief on the usage information and CLI options available.

$ dotnet do --help
DotNet Do [the do]
  The DotNet CLI task runner.
  1.3.1.0

Usage:
  dotnet do <task> [<args>...]
  dotnet do <option>

Options:
  --list                List all available tasks
  --create              Create a new dotnet-tasks.yml
  --version             Show version information
  -?, -h, --help        Show help and usage information

List

dotnet do --list

This will provide you with a list of all the tasks available for you to run at the current directory. This lists the tasks name and description, taking into account any task overriding.

$ dotnet do --list
Tasks available from this directory:
  build             Builds the entire application stack.
  run, start        Builds and runs the entire application stack. 

Create

dotnet do --create

This creates a new tasks file (dotnet-tasks.yml) in the current directory - prepopulated with a single sample task named echo that when run prints "Hello World" - you can then use this new tasks file as a template for your own tasks. If a tasks file already exists in this directory this option will fail.

$ dotnet do --create
A new tasks file (dotnet-tasks.yml) has been created. Try it out with `dotnet do echo`.

Version

dotnet do --version

Prints the semantic version of DotNet Do.

$ dotnet do --version
1.3.1.0