Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 1 KB

USAGE.md

File metadata and controls

55 lines (34 loc) · 1 KB

unit-text CLI usage

unit-text helps you write unit tests for prose. It uses ✨ agents ✨ to ensure that you meet the target audience's expectations, and that your writing achieves the desired outcomes.

Usage:

$ unit-text [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • ideate: Generate ideas for your writing.
  • test: Test the input file.

unit-text ideate

Generate ideas for your writing.

Usage:

$ unit-text ideate [OPTIONS]

Options:

  • --output PATH: The output file to write the ideas to. [default: unit-text.json]
  • --help: Show this message and exit.

unit-text test

Test the input file.

Usage:

$ unit-text test [OPTIONS] FILE

Arguments:

  • FILE: [required]

Options:

  • --config PATH: The config file. [default: unit-text.json]
  • --help: Show this message and exit.