[Utility] CLI Usage instructions and specification

[deblasis]

Objective

Write a User Usage and a specification documenting the CLI features, quirks and whatnot, extending what has been (or not) already written in the CLI README (app/client/cli/doc/README.md)

This issue builds on top of #169 (in case it hasn't been merged into main at the time of reading)

Origin Document

The CLI is going to be a multipurpose tool used by several personas interacting with Pocket Network.
We need a clear, detailed but concise document that covers the basics and HOWTOs when using and also developing/extending the CLI.

Goals

• Provide enough context and information so that all the basics and the foresaw FAQs about the CLI are covered.

Deliverable

• A good CLI should be user-friendly and its use should feel natural. This means that the inline help provided by the CLI (Cobra) is also part of the documentation (for the user usage part)
• The specifications should also cover a top-down description of the architecture of the module
• Updated app/client/cli/doc/README.md

Non-goals / Non-deliverables

• Do not cover the RPC spec since it's considered an implementation detail that might change and it's however documented in the relevant module.

General issue deliverables

• Update the appropriate CHANGELOG
• Update any relevant READMEs (local and/or global)
• Update any relevant global documentation & references
• If applicable, update the source code tree explanation
• If applicable, add or update a state, sequence or flowchart diagram using mermaid

[Optional] Testing Methodology

• Task specific tests: make ...
• All tests: make test_all
• LocalNet: verify a LocalNet is still functioning correctly by following the instructions at docs/development/README.md

---

Creator: @deblasis
Co-Owners: ??

[deblasis]

First stab here e5c3ae5

I think that the .md files should not be gitignored and that instead should be refreshed automatically anytime we merge a PR that has changes in the CLI folder... it can be achieved by playing with git in github workflows.

For now, I guess that we could do this manually... every time we update the CLI, we need to regenerate the docs via

make generate_cli_commands_docs

[jessicadaugherty]

Refactor against #235, which has been merged to main

[deblasis]

@Olshansk I believe this can be closed as part of #112 (since I have added the docs generator), do you agree or do you feel like there's more work to do here?

[Olshansk]

@Olshansk I believe this can be closed as part of #112 (since I have added the docs generator), do you agree or do you feel like there's more work to do here?

💯% agreed!