Update CLI documentation #69
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
- Update usage section in the README with the latest flags. - Update default sample output (BoardState fields have changed, OutOfBounds has been removed). - Add section describing options for getting JSON output with the `--output` and `--debug-requests` flag.
jlafayette
requested review from
robbles,
bvanvugt and
chris-bsnake
as code owners
robbles
approved these changes
Apr 11, 2022
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.
While trying to answer a question from discord, I noticed that the usage and sample output for the CLI is out of date. I also thought it would be good to highlight different ways of getting JSON output that is better suited to parsing with a script. Please let me know if this could be worded more clearly!
Changes:
--outputand--debug-requestsflag.