feat(iroh-cli): improve ergonomics of iroh gossip subscribe CLI cmd

[matheus23]

Description

Previously the gossip command could be confusing:

$ iroh gossip subscribe test --start
error: invalid value 'test' for '[BOOTSTRAP]...': decoding: base32: non-zero trailing bits at 3

Now, the output is more helpful:

$ iroh gossip subscribe test --start
error: the following required arguments were not provided:
  <--topic <TOPIC>|--raw-topic <RAW_TOPIC>>

Usage: iroh gossip subscribe --start <--topic <TOPIC>|--raw-topic <RAW_TOPIC>> <BOOTSTRAP>...

For more information, try '--help'.

And the help text also contains examples & explanation on how the command works.

Breaking Changes

None. The command still works the same way.

Notes & open questions

Closes #2698

Should we rename the command? When I read gossip subscribe initially, I thought a gossip publish command may be missing. But actually gossip subscribe does both.
Perhaps gossip join may be better?
But also: We want to keep the CLI names in sync with the names in the code API. Perhaps we should rename the API call to be join instead of subscribe? Or perhaps something like open_topic?
Anyhow - perhaps that's food for thought & another PR.

Change checklist

• Self-review.
• Documentation updates following the style guide, if relevant.
• [ ] Tests if relevant.
• All breaking changes documented.

[github-actions]

Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/2751/docs/iroh/

Last updated: 2024-09-30T08:40:35Z

[dignifiedquire]

thanks, at least now one can figure out how to use it 😅

[github-actions]

Netsim report & logs for this PR have been generated and is available at: LOGS
This report will remain available for 3 days.

Last updated for commit: 52626d4