跳到主要内容

Hyperlane 命令行工具

概述

Hyperlane 命令行工具是用于将 Hyperlane 合约部署到新链的官方命令行工具。它还包含了与已部署合约和注册表交互的实用工具。

已发布版本可在 NPM 上获取。源代码可在 GitHub monorepo 中找到。

设置

提示

需要 Node 18 或更新版本

要全局安装命令行工具,请使用 npm install -g 命令。这将使 hyperlane 命令在终端的任何位置都可用。

# 使用 NPM 安装
npm install -g @hyperlane-xyz/cli
# 或卸载旧版本
npm uninstall -g @hyperlane-xyz/cli

或者,对于运行单个命令,你可以使用 npxdlx:

# 通过 NPM 的 npx 命令运行
npx @hyperlane-xyz/cli
# 或通过 Yarn 的 dlx 命令
yarn dlx @hyperlane-xyz/cli

使用方法

要查看可用命令及其参数的列表,运行 hyperlane --help

一些常用的命令选项包括:

  • --version: 显示当前安装的命令行工具版本
  • --registry: 设置用于链元数据和合约地址的注册表 URI
  • --overrides: 设置规范注册表数据的额外覆盖路径
  • log: 设置命令行工具的日志格式(默认为 pretty)
  • verbosity: 设置命令行工具的日志级别(默认为 info)
  • key: 设置用于签署交易的密钥(默认为 HYP_KEY 环境变量)

注册表

默认情况下,命令行工具将从规范 Hyperlane 注册表获取链元数据和合约地址,但会将新的配置和部署写入到本地文件系统。更多信息请参见注册表页面