Add --json-output flag documentation for CLI commands
#558
Conversation
This file contains hidden or 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
JoshuaBatty
force-pushed
the
josh/json_cli
branch
from
f5faabc to
d080d06
Compare
Document the new --json flag that outputs results in machine-readable JSON format: - Add --json to Universal Flags in CLI overview - Add JSON Output sections to deploy and run command docs with examples
JoshuaBatty
force-pushed
the
josh/json_cli
branch
from
d080d06 to
0c3f643
Compare
AleoAlexander
requested changes
Dec 22, 2025
Collaborator
AleoAlexander
left a comment
AleoAlexander
left a comment
There was a problem hiding this comment.
One minor change, but otherwise LGTM!
Co-authored-by: Alexander Kim <alexander@aleo.org> Signed-off-by: Joshua Batty <joshpbatty@gmail.com>
Collaborator
Author
|
I'm making some changes to the linked PR that change the definition. Will put this in draft until we have finalised the CLI implementation. |
- Rename --json to --json-output - Document default output location (build/json-outputs/<command>.json) - Document custom path option (--json-output=path) - Remove stdout piping examples (no longer needed)
JoshuaBatty
changed the title
--json flag documentation for CLI commands--json-output flag documentation for CLI commands
Collaborator
Author
|
@AleoAlexander This is ready for review again now. The CLI changes have been merged in the linked PR. Thanks. |
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.
Documents the
--json-outputflag for saving structured CLI output to disk.Changes
build/json-outputs/<command>.json--json-output=path/to/file.jsondeploy,upgrade,run,execute,test,query,synthesizeRelated implementation: ProvableHQ/leo#29051