Joystream / Joystream/joystream
CLI: Improving the UX (plugins, command name aliases)
@Lezek123 is already working on this.
Since Jul 22, 2020.
- Dominant language
- Rust
- Stars
- 1.4k
- Forks
- 116
- PR merge metrics
- No merged PRs in 30d
Description
As the number of commands in the CLI grows it's getting hard to remember / type the exact command that we wish to execute. I ran into this issue multiple times when testing the CLI. Obviously we can use --help flag to find the exact name of the command, but this is quite suboptimal, especially when the help output becomes very long (see: working-groups)
There are a few things we can do to address this, ie. adding a few oclif plugins (https://oclif.io/docs/plugins) seems like a very high-value low-effort solution:
- add
@oclif/plugin-autocomplete(bash autocomplete) - add
@oclif/plugin-not-found(did you mean... message in case of typo) - create a few aliases for command names (which are very easy to add), ie.:
startReviewPeriod+beginReviewPeriod - optionally add
@oclif/plugin-warn-if-update-available(not strictly related to this issue, but seems like a good plugin to have too)
┆Issue is synchronized with this Asana task by Unito
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.
Assessment
This issue has not been assessed yet.