Overview
The Hyperlane CLI is the official command-line tool for deploying Hyperlane contracts to new chains. It also includes utilities for interacting with deployed contracts and registries. The published version is available on NPM. The source is available on GitHub in the monorepo.Setup
Node 18 or newer is required
npm install -g
command. This will the hyperlane
command available anywhere in your terminal.
npx
or dlx
:
Usage
To view a list of the available commands and their arguments, runhyperlane --help
.
A few common command options include:
--version
: Display your current installed version of the CLI--registry
: Set the registry URI to use for chain metadata and contract addresses--overrides
: Set an additional path for overrides to the canonical registry datalog
: Set the log format for the CLI (defaults to pretty)verbosity
: Set the log level for the CLI (defaults to info)key
: Set the key to use for signing transactions (defaults to the HYP_KEY env var)