docs: add indexerUrl to deploy CLI docs (#3416)

latticexyz · Jan 6, 2025 · 706f2e0 · 706f2e0
1 parent 509a3cc
commit 706f2e0
Showing 1 changed file with 16 additions and 15 deletions.
diff --git a/docs/pages/cli/deploy.mdx b/docs/pages/cli/deploy.mdx
@@ -37,21 +37,22 @@ Again, there are several ways to do this:
 
 These are the command line options you can specify on `mud deploy`:
 
-| Option                  | Meaning                                          | Type    | Default value                                              |
-| ----------------------- | ------------------------------------------------ | ------- | ---------------------------------------------------------- |
-| `--configPath`          | Path to the config file                          | string  | `mud.config.ts`                                            |
-| `--printConfig`         | Print the resolved config                        | boolean | `false`                                                    |
-| `--saveDeployment`      | Save the deployment info to a file               | boolean | `true`                                                     |
-| `--profile`             | The foundry profile to use                       | string  | `local`                                                    |
-| `--rpc`<sup>1</sup>     | The RPC URL to use                               | string  | RPC url from `foundry.toml`                                |
-| `--rpcBatch`            | Enable batch processing of RPC requests          | boolean | `false`                                                    |
-| `--worldAddress`        | Deploy to an existing World at the given address | string  | Empty, deploy new `World`                                  |
-| `--srcDir`              | Source directory                                 | string  | Foundry `src` directory                                    |
-| `--skipBuild`           | Skip rebuilding the contracts before deploying   | boolean | `false`                                                    |
-| `--alwaysRunPostDeploy` | Run `PostDeploy.s.sol` after each deploy         | boolean | `false` (run the script only when deploying a new `World`) |
-| `--help`                | Show help                                        | boolean | `false`                                                    |
-| `--version`             | Show version number                              | boolean | `false`                                                    |
-| `--forgeScriptOptions`  | Command line options for forge                   | string  | empty                                                      |
+| Option                  | Meaning                                                                          | Type    | Default value                                              |
+| ----------------------- | -------------------------------------------------------------------------------- | ------- | ---------------------------------------------------------- |
+| `--configPath`          | Path to the config file                                                          | string  | `mud.config.ts`                                            |
+| `--printConfig`         | Print the resolved config                                                        | boolean | `false`                                                    |
+| `--saveDeployment`      | Save the deployment info to a file                                               | boolean | `true`                                                     |
+| `--profile`             | The foundry profile to use                                                       | string  | `local`                                                    |
+| `--rpc`<sup>1</sup>     | The RPC URL to use                                                               | string  | RPC url from `foundry.toml`                                |
+| `--rpcBatch`            | Enable batch processing of RPC requests                                          | boolean | `false`                                                    |
+| `--worldAddress`        | Deploy to an existing World at the given address                                 | string  | Empty, deploy new `World`                                  |
+| `--srcDir`              | Source directory                                                                 | string  | Foundry `src` directory                                    |
+| `--skipBuild`           | Skip rebuilding the contracts before deploying                                   | boolean | `false`                                                    |
+| `--alwaysRunPostDeploy` | Run `PostDeploy.s.sol` after each deploy                                         | boolean | `false` (run the script only when deploying a new `World`) |
+| `--help`                | Show help                                                                        | boolean | `false`                                                    |
+| `--version`             | Show version number                                                              | boolean | `false`                                                    |
+| `--forgeScriptOptions`  | Command line options for forge                                                   | string  | empty                                                      |
+| `--indexerUrl`          | If provided, read records from the indexer instead of fetching logs from the RPC | string  | empty                                                      |
 
 (1) The hostname `localhost` may not work. If that is the case, use `127.0.0.1` instead.