-
Notifications
You must be signed in to change notification settings - Fork 17
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
Organise hash and ping commands #1048
Merged
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
Jimbo4350
reviewed
Feb 4, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Available options:
--version Show the cardano-cli version
-h,--help Show this help text
Available commands:
address Payment address commands.
key Key utility commands.
node Node operation commands.
query Node query commands. Will query the local node whose
Unix domain socket is obtained from the
CARDANO_NODE_SOCKET_PATH environment variable.
legacy Legacy commands
Byron specific commands
byron Byron specific commands
Available commands:
shelley Shelley era commands - DEPRECATED - will be removed
in the future
allegra Allegra era commands - DEPRECATED - will be removed
in the future
mary Mary era commands - DEPRECATED - will be removed in
the future
alonzo Alonzo era commands - DEPRECATED - will be removed in
the future
babbage Babbage era commands - DEPRECATED - will be removed
in the future
conway Conway era commands
latest Latest era commands (Conway)
hash Compute the hash to pass to the various --*-hash
arguments of commands.
ping Ping a cardano node either using node-to-node or node-to-client protocol. It negotiates a handshake and keeps sending keep alive messages.
debug commands
debug Debug commands
Miscellaneous commands
help Show all help
version Show the cardano-cli version
Available commands:
compatible Limited backward compatible commands for testing
only.
The point was to move hash and ping commands away from the era based commands.
I didn't see a diff for that in our golden test files. So if we don't have a test for this:
- We need to add
- We need to confirm the commands have been moved from the relevant `Available Commands" section.
de0f11f
to
4794bbf
Compare
Jimbo4350
approved these changes
Feb 4, 2025
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.
Changelog
Context
There are a lot of commands in the root level of the
cardano-cli
, this small tweak aims to improve the readability of the main help message, and make things easier to find.How to trust this PR
I would check the changes to the help golden files, and ensure the code was re-organised correctly and sensibly.
This is the new output of
cardano-cli --help
:Checklist