adapt commands cli #116
Merged
adapt commands cli #116
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
👋 aelmanaa, thanks for creating this pull request! To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team. Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks! |
Coverage Report |
andrevmatos
previously approved these changes
Jan 27, 2026
andrevmatos
approved these changes
Jan 27, 2026
AndresJulia
approved these changes
Jan 27, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This pull request introduces a major redesign of the CLI argument structure for the
ccip-clitool, aligning it with industry-standard CLI conventions and improving usability and safety. The changes affect both the documentation and the implementation of several commands, notablysend,getSupportedTokens, andtoken. The update replaces positional arguments with named arguments for commands with multiple or similar-type parameters, clarifies alias usage, and updates help texts and examples throughout the codebase and documentation.CLI Argument Standardization and Usability Improvements:
Converted major commands (
send,getSupportedTokens,token) to use named arguments (e.g.,--source,--dest,--router) instead of positionals, preventing argument order mistakes and improving clarity. This includes updating aliases and help texts for all relevant options. [1] [2] [3] [4] [5] [6] [7]Updated CLI documentation in
README.mdandCONTRIBUTING.mdto reflect new argument conventions, provide rationale for argument design, and add detailed guidelines and examples for contributors and users. [1] [2] [3] [4] [5] [6]Changed the global RPC option from
-r/--rpcsto--rpc/--rpcsto avoid conflicts;-ris now reserved for command-specific options like--router. Updated all relevant documentation and tests. [1] [2] [3] [4]Command-Specific Enhancements:
sendcommand: Now uses named arguments for source, destination, and router; improved help descriptions and added usage examples. [1] [2] [3]getSupportedTokenscommand: Now uses named arguments for network and address, with optional token; updated documentation and examples. [1] [2] [3]Introduced a new
tokencommand for querying native and token balances, using named arguments for network and holder, with optional token address. [1] [2]SDK and Internal Improvements:
NetworkTypeenum andnetworkTypeproperty toNetworkInfoin the SDK, and improved selector generation script validation.These changes collectively make the CLI safer, more intuitive, and easier to maintain, while also aligning with best practices from other major CLI tools.