CLI Reference

This page provides documentation for the command line task2md application.

dir

Command to generate a markdown documentation file from a directory.

Raises: click.ClickException: Error when reading input file or writing output file

Usage:

dir [OPTIONS]

Options:

  -i, --input DIRECTORY  Input directory  [required]
  -d, --dir DIRECTORY    Output markdown documentation files directory.
                         Default current directory.
  --help                 Show this message and exit.

file

Command to generate a markdown documentation file from a Task file.

Raises: click.ClickException: Error when reading input file or writing output file

Usage:

file [OPTIONS]

Options:

  -i, --input FILE     Input Task yaml file.  [required]
  -d, --dir DIRECTORY  Output markdown documentation files directory. Default
                       current directory.
  --help               Show this message and exit.