Skip to content

Latest commit

 

History

History
43 lines (22 loc) · 1.12 KB

README.md

File metadata and controls

43 lines (22 loc) · 1.12 KB

Documentation

This directory contains the documentation for this CLI's commands, configuration, and technical details.

For Users Docs

  • Show Commands

    The views that read a controller, with the output each one prints.

  • Action Commands

    The commands that write to a controller, with what each one answers.

  • Other Commands

    The commands that name no target: generate-token and save-config.

  • Customization

    The flags, the environment variables, and the configuration file.

  • Troubleshooting

    Every error message this CLI prints, and what to do about each.

  • Help

    The help text of every command except completion.

For Developers Docs

  • Architecture

    The output contract, the absence rule, the exit codes, and the order every write keeps.

  • Measurements

    Every reading taken on a live controller, and the gaps.

  • Testing

    The conventions, the invariants, and the checks that need a live controller.