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.
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.
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. |
|
What about generating tab completion for commands and arguments for the user? This would allow them to see all available commands and eliminate the need to memorize short versions of commands. |
|
You also can find good example of autocomplete in rustup completions --help |
3 participants
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