EDU-2415: Improve CLI Help content #561
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also:
* Adds language for `temporal`, `temporal activity`, `temporal activity
complete` and `temporal activity fail`.
NOTES
* I'm a little confused by the inconsistency of punctuation.
* How wordy do you want the command-line usage to be? There's already an
overwhelming amount of "wall of text".
I was thinking more:
```
* `--env` (string) - Active environment name. Default: default. Env: TEMPORAL_ENV.
* `--env-file` (string) - Path to environment settings file (defaults to `$HOME/.config/temporalio/temporal.yaml`).
* `--log-level` (string-enum) - Log level. Default is "info" for most commands and "warn" for `server start-dev`.
Options: debug, info, warn, error, never. Default: info.
* `--log-format` (string) - Log format. Options are "text" and "json". Default is "text".
* `--output`, `-o` (string-enum) - Non-logging data output format. Options: text, json, jsonl,
none. Default: text.
* `--time-format` (string-enum) - Time format. Options: relative, iso, raw. Default: relative.
* `--color` (string-enum) - Output coloring. Options: always, never, auto. Default: auto.
* `--no-json-shorthand-payloads` (bool) - Show all payloads as raw, even if they are JSON. Default: false.
```
over
```
* `--env` (string) - Read additional options from the `ENV` environment. (See "temporal env --help" for more about environments.) Default: default. Env: TEMPORAL_ENV.
* `--env-file` (string) - Read/store per-environment configuration in `PATH` (defaults to "$HOME/.config/temporalio/temporal.yaml").
* `--log-level` (string-enum) - Log level. Default is "info" for most commands and "warn" for the development server.
Options: debug, info, warn, error, never. Default: info.
* `--log-format` (string) - Emit log messages in "text" or "json" format. Default is "text".
* `--output`, `-o` (string-enum) - Emit output in the `FMT` format. Does not affect logs; use --log-format instead. Options: text, json, jsonl,
none. Default: text.
* `--time-format` (string-enum) - Emit timestamps in the `FMT` format. Options: relative, iso, raw. Default: relative.
* `--color` (string-enum) - Colorize output. Does not affect logs. Options: always, never, auto. Default: auto.
* `--no-json-shorthand-payloads` (bool) - Show all payloads as raw payloads even if they are JSON.
```
ISSUES
1. There's no way to bundle the `temporal` options, which are
imported elsewhere. They have to be there and they are
distracting, and contribute to overwhelmed users.
2. Even though I set a description for complete and fail, they are not shown
cli% ./temporal activity complete
Error: required flag(s) "activity-id", "result", "workflow-id" not set
Usage:
temporal activity complete [flags]
Ditto for temporal activity fail.
Proof of concept material is pretty much there before I move forward.
fairlydurable
commented
May 14, 2024
fairlydurable
commented
May 14, 2024
fairlydurable
commented
May 14, 2024
fairlydurable
commented
May 14, 2024
fairlydurable
commented
May 14, 2024
fairlydurable
commented
May 14, 2024
fairlydurable
commented
May 14, 2024
fairlydurable
commented
May 14, 2024
fairlydurable
commented
May 14, 2024
josh-berry
reviewed
May 15, 2024
josh-berry
approved these changes
Jul 11, 2024
And conflict resolution
Also adds alias coverage to contribution guidance
Also Query quick-ref
fairlydurable
changed the title
cretz
reviewed
Jul 23, 2024
|
(note, my opinions are just general notes about formatting, they are not meant to block others' approval and will defer to others stewarding this project) |
All comments are appreciated and valuable. Thank you. |
josh-berry
reviewed
Jul 23, 2024
Also addresses EDU-2651
josh-berry
reviewed
Jul 24, 2024
Co-authored-by: Josh Berry <josh.berry@temporal.io>
Thanks! Will wait for the rest. Otherwise I'm doing a failover to the "Write short tutorials" region of my workday. |
Co-authored-by: Josh Berry <josh.berry@temporal.io>
Co-authored-by: Josh Berry <josh.berry@temporal.io>
|
@fairlydurable Here are my changes for you to review, including reverting some unintentional functional changes: 755b2bb#diff-b4c85d71e771b938a0779d1e4113e068c19dd896aac86c04fe1828dd5a15c63f I wrote a small tool to check for unintentional functional changes so I'm pretty confident this will take care of the build issues as well. (Will consider throwing it up in a separate PR once cleaned up.) |
1 task
Open
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is up to date as of mid-day 23 July.
Note: This will not compile in its current state.
Ready for Josh's review.