Community Feedback Requested: CLI Refactor

Ziti Overlay
1

Hi everyone,
We've been discussing doing some cleanup of the OpenZiti CLI. Here is a write-up describing the changes: ziti/doc/cli-2.0.md at ea3aced311ccfff30f7c25554a88190afafd27d1 · openziti/ziti · GitHub

TL;DR -

  1. Have two layouts that one can switch between for backwards compatibility
  2. Add all of the old layout to the new layout, for backwards compatibility (with one exception b/c of a namespace conflict)
  3. New layout tries to consistently use the form ziti <verb> <noun> and drops the fabric and edge sub-commands.
    1. Ex: ziti edge create service becomes ziti create service
    2. Ex: ziti controller run becomes ziti run controller

The downside to making CLI changes is that it will require reworking a lot of documentation. Even with backwards compatibility, old videos tutorial will become out of date.

So, the questions we have are:

Are you a heavy CLI user?

  • Use it all the time
  • Use it occasionally
  • Use it rarely/never
0 voters

Are you happy with the current ClI layout?

  • It's great!
  • It's good enough
  • I find it annoying or confusing
0 voters

If you've taken a look at the proposed layout, what's your reaction?

  • Not worth the effort/churn
  • It would reduce some annoyance or confusion
  • It would be a big quality of life improvement
  • It's not just unnecessary, it's bad
0 voters

If you've got more verbose feedback, leave a reply or send a DM. Feel free to leave a comment on the PR as well: Complete new CLI layout by plorenz · Pull Request #3564 · openziti/ziti · GitHub

Thank you!
Paul

2 Likes