Description
Goal
The CLI commands for Core and Enterprise are currently very difficult to find, understand, and configure easily. Using the --help
options immediately overwhelms the user with an intense cognitive load.
Proposed Approach
We move to a --help
and a --help-all
approach, where the --help-all
option would display all options. I’m also suggesting we move to grouped commands.
The proposed approach strives for three things:
- Simplifying the number of options shown by default to reduce cognitive overload, especially for just getting started.
- Reorganizes commands / options in preferred and logical order; what people most likely will use comes first in organized buckets.
- Limiting the amount of text explaining options – that should reside in docs, which is linked at the bottom of the
--help
command.
Given Enterprise builds on top of Core, all commands/options ordering should remain the same, with Enterprise's additional commands/options falling into their respective areas.
Tasks
There are several tasks as part of this epic, each focused on improving a certain section of the CLI, and tagged below.
- influxdb3 --help
- influxdb3 --help-all
- influxdb3 serve --help
- influxdb3 serve --help-all
- ...
Subtasks will be created for each command with explanation on required output for the --help
command.