Documentation for CLI Commands
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2
- Forks
- 2
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 4
Description
We should create something similar to the [CLI docs in MADA Tools](https://software.llnl.gov/mada-tools/develop/user_guide/cli/).
@llnl/mada As part of this I'm wondering about entry points to this library. Currently you can use two versions of every command (e.g., `mada cli` or `mada-cli`). I think this might get confusing to users. I'd like to start a discussion here as to whether we should leave this or reduce to a single version. If so, which is better?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the linked MADA Tools CLI documentation and inspecting the project's current command entry points. Clarify whether both `mada cli` and `mada-cli` should remain, then document the agreed command interface and its usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100