Skip to content
This repository was archived by the owner on Jul 15, 2025. It is now read-only.

feat: multiple overrides documentation #298

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+3 −3
Open

feat: multiple overrides documentation #298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b453bae
Update registries.mdx
mkykadir Jan 21, 2025
0c92144
Update cli.mdx
mkykadir Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/reference/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ To view a list of the available commands and their arguments, run `hyperlane --h
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 data
- `--overrides`: Set list of additional paths or Github urls for overrides to the canonical registry data, later override takes priority over previous
- `log`: 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)

## Registries

By default, the CLI will pull chain metadata and contract addresses from the [canonical Hyperlane Registry](https://github.com/hyperlane-xyz/hyperlane-registry) but will write new configs and deployments to your local filesystem. For more information see the [Registries page](/docs/reference/registries.mdx).
By default, the CLI will pull chain metadata and contract addresses from the [canonical Hyperlane Registry](https://github.com/hyperlane-xyz/hyperlane-registry) but will write new configs and deployments to your local filesystem. For more information see the [Registries page](/docs/reference/registries.mdx).
2 changes: 1 addition & 1 deletion docs/reference/registries.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ As long as the registry conforms to the same layout and file schemas as the cano
The CLI has two command line arguments for configuring the registry it uses:

- The `--registry` flag sets the primary registry and uses the default Github registry if not set
- The `--overrides` flag sets an optional additional path which can be useful for forcing specific overrides of the default data, for example to use a different RPC URL in a chain's metadata.
- The `--overrides` flag sets an optional additional list of paths or Github URLs which can be useful for forcing specific overrides of the default data, for example to use a different RPC URL in a chain's metadata.

Once your custom registry additions/updates are complete and tested, consider opening a pull request to the canonical registry so that others can benefit from your deployments.

Expand Down