CCIP CLI
Command-line interface for querying, sending, and managing cross-chain messages on the Chainlink Cross-Chain Interoperability Protocol.
Package
@chainlink/ccip-cliVersion1.1.1
Node.jsv20+ (v24+ recommended)
LicenseMIT
Installation
- npm (global)
- npx (no install)
- From source
Bash
npm install -g @chainlink/ccip-cli
Bash
npx @chainlink/ccip-cli --help
Bash
git clone https://github.com/smartcontractkit/ccip-tools-ts
cd ccip-tools-ts
npm install
./ccip-cli/ccip-cli --help
Quick Start
Before running commands, configure RPC endpoints and wallets. See Configuration for all options.
Track a CCIP message by transaction hash or message ID:
Bash
ccip-cli 0xSourceTxHash...
show is the default command — you can omit it. The CLI displays the full message lifecycle: Lane, Request, Commit, and Execution.
Send a test message (requires a wallet):
Bash
ccip-cli send \
-s ethereum-testnet-sepolia \
-d ethereum-testnet-sepolia-arbitrum-1 \
-r 0x0BF3dE8c5D3e8A2B34D2BEeB17ABfCeBaf363A59 \
--to 0xReceiverAddress \
--data "Hello from CLI!"
Check the fee first without sending (no wallet needed):
Bash
ccip-cli send \
-s ethereum-testnet-sepolia \
-d ethereum-testnet-sepolia-arbitrum-1 \
-r 0x0BF3dE8c5D3e8A2B34D2BEeB17ABfCeBaf363A59 \
--to 0xReceiverAddress \
--only-get-fee
Commands
| Command | Description | Documentation |
|---|---|---|
ccip-cli <tx-hash-or-id> | Track a message (default command) | show |
ccip-cli send -s <source> -d <dest> -r <router> | Send a cross-chain message | send |
ccip-cli manual-exec <tx-hash-or-id> | Execute a pending or failed message | manual-exec |
ccip-cli parse <data> | Decode error data, revert reasons, events | parse |
ccip-cli get-supported-tokens -n <network> -a <addr> | List supported tokens for a router or pool | get-supported-tokens |
ccip-cli token -n <network> -H <holder> | Query native or token balance | token |
ccip-cli lane-latency <source> <dest> | Query real-time lane latency | lane-latency |
Next Steps
- Configuration — RPC endpoints, wallets, global options
- Debugging Failed Messages — Track, debug, and manually execute
- Token Transfer Workflow — Send tokens cross-chain
- Troubleshooting — Common errors and solutions