HydrologicEngineeringCenter / HydrologicEngineeringCenter/cwms-cli

Add Overall Arguments Doc

Open
#161 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
2
Forks
4
Avg merge
19h 59m
Merged PRs (30d)
3

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the cwms-cli command help output and locating the existing quick start guide or FAQ. Document where overall arguments such as --log-file and --log-level belong relative to subcommands, with a visual or highlighted sections if the documentation format supports it; done means users can identify the correct argument level without relying on separate -h output.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.