From 2b57b66f460894a1da37a1f738db0aa3c5a1dab0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Muhammed=20Kadir=20Y=C3=BCcel?= <mky515@gmail.com> Date: Tue, 21 Jan 2025 13:14:41 +0300 Subject: [PATCH 1/2] Update registries.mdx Add Github auth token flag documentation --- docs/reference/registries.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/reference/registries.mdx b/docs/reference/registries.mdx index 481ee1c8..1444d3aa 100644 --- a/docs/reference/registries.mdx +++ b/docs/reference/registries.mdx @@ -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. From 9a4d6710a1a2d0819657f54203393086bf7538ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Muhammed=20Kadir=20Y=C3=BCcel?= <mky515@gmail.com> Date: Tue, 21 Jan 2025 13:15:49 +0300 Subject: [PATCH 2/2] Update cli.mdx Add Github Authtoken CLI documentation --- docs/reference/cli.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/reference/cli.mdx b/docs/reference/cli.mdx index b3d991e9..41f4321b 100644 --- a/docs/reference/cli.mdx +++ b/docs/reference/cli.mdx @@ -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). \ No newline at end of file +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).