Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Github authToken documentation #297

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

feat: Github authToken documentation #297

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
2b57b66
Update registries.mdx
mkykadir Jan 21, 2025
9a4d671
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
3 changes: 2 additions & 1 deletion docs/reference/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,11 @@ 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
- `--authToken`: Set an Github authentication token for Github registry
- `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).
1 change: 1 addition & 0 deletions docs/reference/registries.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ 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 `--authToken` flag sets an opitonal Github authentication token to be used for Github registry, so private repositories can be used as registry as well.

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