Trying ockam CLI and giving user experience feedback #3631

[h3athen]

End-to-End Trustful communication using Relays.

-- APPLICATION SERVICE --

- Create a relay node that will relay end-to-end encrypted messages

---

- Start a application service and listening on a local ip and port

---

- Setup an ockam node, called blue, as a sidecar next to our application service.

- Create a tcp outlet on the blue node to send raw tcp traffic to the application service.

- Then create a forwarder on the relay node to blue.

---

-- APPLICATION CLIENT --

- Setup an ockam node, called green, as a sidecar next to our application client.

- Then create an end-to-end encrypted secure channel with blue, through the relay.

- Then tunnel traffic from a local tcp inlet through this end-to-end secure channel.

---

- Accessing the application service though the end-to-end encrypted, secure relay

---

Feedback

I found it easy to use the cli tool from a first timer's perspective since passing the argument was much simpler. For example
ockam tcp-outlet create --at /node/blue --from /service/outlet --to 127.0.0.1:5000 - by just looking at the command we can tell what its doing. Creating a tcp outlet at blue node from service outlet to an address. This really helps people to remember the format.

The other helpful thing about the tools was typo suggestion. As mentioned in the step, we can use ockam reset to start from the beginning. And I thought why not pass some other argument and see how it behaves.

The tool pointed out my typo and suggested me a solution.

The only changes I would want (totally personal) is when I run ./ockam and ./ockam -h, it provides me the same output which is really long with extra infos such as ABOUT, EXAMPLE etc. So it would be better for me if when I run ./ockam -h it would just provide me with infos such as USAGE, OPTIONS, GLOBAL OPTIONS and SUBCOMMANDS. And when I run ./ockam, it gives me those other extra infos. The other alternate would be to just provide extra infos while running ./ockam and keep the usage options only in --help tag.

Apart from that the user experience from my side was great 🦀 <#

[mrinalwadhwa]

@h3athen thank you, that is extremely helpful feedback 🥳
Great suggestion about making long help and short help separate. Work in that direction has already started in #3622 and #3434

[h3athen]

Thank you 😊