-
Notifications
You must be signed in to change notification settings - Fork 88
added single-letter aliases for top-level cli commands (issue #229) #231
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
base: master
Are you sure you want to change the base?
added single-letter aliases for top-level cli commands (issue #229) #231
Conversation
|
Hello @chahat-101 , thank you for opening the PR on this issue. I suggest also shortening the subcommands for example; using the Also adding what each aliases point to in the |
|
@AmosOO7 I agree that this could be useful, would you like me to extend this PR with subcommand aliases and readme updates, or handle that in a follow-up PR? |
Hello @chahat-101 |
|
Hey @AmosOO7 |
|
Hello @chahat-101, nice work. I like the aliases you used for the subcommands. |
| /// Returns the available spending policies for the descriptor. | ||
| Policies, | ||
| /// Returns the public version of the wallet's descriptor(s). | ||
| #[command(alias = "pub_desc")] |
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.
Hello @chahat-101
I noticed you didn't add extract_psbt , finalize_psbt, and combine_psbt under the wallet subcommand.
| ## Command Aliases | ||
|
|
||
| bdk-cli provides short aliases for commonly used commands to improve CLI ergonomics. | ||
|
|
||
| ### Top-level command aliases | ||
|
|
||
| | Command | Alias | | ||
| |------------|-------| | ||
| | wallet | W | | ||
| | key | K | | ||
| | compile | C | | ||
| | repl | R | | ||
| | descriptor | D | | ||
|
|
||
| ### Wallet subcommand aliases | ||
|
|
||
| | Command | Alias | | ||
| |---------------------|-------| | ||
| | new_address | new_addr | | ||
| | unused_address | unused_addr | | ||
| | create_tx | create | | ||
| | bump_fee | bump | | ||
| | public_descriptor | pub_desc | | ||
|
|
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.
I advice moving this section to below the pretty section
|
Thanks! I initially focused on wallet subcommands to keep the scope incremental and aligned with the original issue. I’m happy to add aliases for subcommands of other top-level commands as well if that’s preferred. |
This PR adds single-letter aliases for top-level CLI commands to improve ergonomics.
Added aliases:
No behavior changes; aliases map directly to existing commands.
Closes #229