Skip to content

Add Overall Arguments Doc #161

Description

@krowvin

CLI Script

Documentation

Feature Proposal

Working through the cwms-cli commands it has gotten to a point where each sub command has various arguments you can (optionally) add to it as you drill down to what you want.

Suggest we create a FAQ (or add this to a the quick start guide) to help bring light to where you might put what argument.

For example if you want to do log-level/log-file that is done right after the cwms-cli command

i.e.
cwms-cli --log-file="./file.log" --log-level=DEBUG ...etc

This helps to keep each -h output concise and shows them at the level they are available. Meaning you could apply those two args before any command following (load/users/etc)

On the doc page color highlighting the sections and a visual could help.

REDACTED relevant log output

Related Context or Links

No response

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions