-
Notifications
You must be signed in to change notification settings - Fork 889
Improve presentation of admin options #6055
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
I took a stab at organizing our CLI options. At the time of writing, we have 42 top-level categories. The presentation can be drastically improved by grouping them (and hiding ones that are pretty irrelevant to 99% of users) I used General"access_url", Authentication"scim_api_key", Workspace builds"provisioner", Workspace connections"derp", Security"max_session_expiry", Monitoring & documentation"logging", Extras"agent_fallback_troubleshooting_url", One concept$ coder server --help
Showing general configuration options:
For a list of all options: `coder server help --all`
or visit https://coder.com/docs/v2/latest/cli/coder_server
General:
--access-url string External URL to access your
(consumes $CODER_ACCESS_URL) deployment. This must be accessible
by all provisioned workspaces.
--http-address string HTTP bind address of the server.
(consumes $CODER_HTTP_ADDRESS) Unset to disable the HTTP endpoint.
(default "127.0.0.1:3000")
...all general options
Authentication:
Run `coder server --help authentication` to see available options
Workspace builds:
Run `coder server --help workspace-builds` to see available options
...all categories Then we could also change https://coder.com/docs/v2/latest/cli/coder_server or https://coder.com/docs/v2/latest/admin/configure to have different groups and display the options in a table. Open to other ideas though! |
I've found it quite clunky to inform users about new flags via email or Slack. I end up sending them a snippet of the |
This seems to be fixed by the flags work! |
Related #6002
Right now,
coder server --help
is overwhelmingly long and unorganized. Perhaps we could section of the flags, e.g. group all scheduling flags together? Also, we should hide some flags (e.g. obscure security knobs) and just list them in the docs.Related is improving our CLI docs experience. This is almost unusable.
The text was updated successfully, but these errors were encountered: