[docs] Update localnetwork (#24437)

stefan-mysten · web-flow · commit d16d497da74c · 2025-11-26T08:09:12.000-08:00
## Description 

Describe the changes or additions included in this PR.

## Test plan 

How did you test the new or updated feature?

---

## Release notes

Check each box that your changes affect. If none of the boxes relate to
your changes, release notes aren't required.

For each box you select, include information after the relevant heading
that describes the impact of your changes that a user might notice and
any actions they must take to implement updates.

- [ ] Protocol: 
- [ ] Nodes (Validators and Full nodes): 
- [ ] gRPC:
- [ ] JSON-RPC: 
- [ ] GraphQL: 
- [ ] CLI: 
- [ ] Rust SDK:
- [ ] Indexing Framework:
diff --git a/crates/sui/src/sui_commands.rs b/crates/sui/src/sui_commands.rs
@@ -204,9 +204,9 @@ pub enum SuiCommand {
     /// may break. Changing these values outside of local networks is very dangerous.
     #[clap(name = "start", verbatim_doc_comment)]
     Start {
-        /// Config directory that will be used to store network config, node db, keystore
+        /// Config directory that will be used to store network config, node db, keystore.
         /// sui genesis -f --with-faucet generates a genesis config that can be used to start this
-        /// proces. Use with caution as the `-f` flag will overwrite the existing config directory.
+        /// process. Use with caution as the `-f` flag will overwrite the existing config directory.
         /// We can use any config dir that is generated by the `sui genesis`.
         #[clap(long = "network.config")]
         config_dir: Option<std::path::PathBuf>,
diff --git a/docs/content/guides/developer/sui-101/local-network.mdx b/docs/content/guides/developer/sui-101/local-network.mdx
@@ -36,23 +36,60 @@ Options and flags like `with-indexer`, `with-graphql`, and related require you t
 The following is a list of possible options and flags to pass to `sui start`:
 
 ```
-    --network.config <CONFIG_DIR>            Config directory that will be used to store network config, node db, Keystore sui genesis -f --with-faucet generates a genesis config that can be used to start this process. Use with caution as the `-f` flag
-                                             will overwrite the existing config directory. We can use any config dir that is generated by the `sui genesis`
-    --force-regenesis                        A new genesis is created each time this flag is set, and state is not persisted between runs. Only use this flag when you want to start the network from scratch every time you run this command
-    --with-graphql[=<WITH_GRAPHQL>]          Start a GraphQL server on localhost and port: 127.0.0.1:9125, or on the port provided. When providing a specific value, please use the = sign between the flag and value: `--with-graphql=6125`. Note that
-                                             GraphQL requires a running indexer
-    --with-faucet[=<WITH_FAUCET>]            Start a faucet with default host and port: 127.0.0.1:9123, or on the port provided. When providing a specific value, please use the = sign between the flag and value: `--with-faucet=6123`
-    --with-indexer[=<WITH_INDEXER>]          Start an indexer with default host and port: 0.0.0.0:9124, or on the port provided. When providing a specific value, please use the = sign between the flag and value: `--with-indexer=6124`.                                          The indexer be started in writer mode and reader mode
-    --fullnode-rpc-port <FULLNODE_RPC_PORT>  Port to start the Fullnode RPC server on. Default port is 9000 [default: 9000]
-    --pg-port <PG_PORT>                      Port for the Indexer Postgres DB. Default port is 5432 [default: 5432]
-    --pg-host <PG_HOST>                      Hostname for the Indexer Postgres DB. Default host is localhost [default: localhost]
-    --pg-db-name <PG_DB_NAME>                DB name for the Indexer Postgres DB. Default DB name is sui_indexer [default: sui_indexer]
-    --pg-user <PG_USER>                      DB username for the Indexer Postgres DB. Default username is postgres [default: postgres]
-    --pg-password <PG_PASSWORD>              DB password for the Indexer Postgres DB. Default password is postgrespw [default: postgrespw]
-    --epoch-duration-ms <EPOCH_DURATION_MS>  Set the epoch duration. Can only be used when `--force-regenesis` flag is passed or if there's no genesis config and one will be auto-generated. When this flag is not set but `--force-regenesis` is set, the
-                                             epoch duration will be set to 60 seconds
-    --no-full-node                           Start the network without a fullnode
--h, --help                                   Print help (see more with '--help')
+    --network.config <CONFIG_DIR>
+          Config directory that will be used to store network config, node db, keystore. sui genesis -f --with-faucet generates a genesis config that can be used to start this process. Use with caution as the `-f` flag will overwrite the existing config
+          directory. We can use any config dir that is generated by the `sui genesis`
+
+    --force-regenesis
+        A new genesis is created each time this flag is set, and state is not persisted between runs. Only use this flag when you want to start the network from scratch every time you run this command.
+        
+        To run with persisted state, do not pass this flag and use the `sui genesis` command to generate a genesis that can be used to start the network with.
+
+    --with-faucet[=<FAUCET_HOST_PORT>]
+        Start a faucet with default host and port: 0.0.0.0:9123. This flag accepts also a port, a host, or both (e.g., 0.0.0.0:9123). When providing a specific value, please use the = sign between the flag and value: `--with-faucet=6124` or
+        `--with-faucet=0.0.0.0`, or `--with-faucet=0.0.0.0:9123`
+
+    --with-indexer[=<DATABASE_URL>]
+        Start an indexer with a PostgreSQL database.
+        
+        Three modes of operation: - Not specified: No indexer is started (unless --with-graphql is set) - `--with-indexer`: Create/use a temporary database in the network's configuration directory - `--with-indexer=<URL>`: Use the provided PostgreSQL
+        database URL
+        
+        When providing a database URL, use the = sign: `--with-indexer=postgres://user:pass@host:5432/db`
+
+    --with-consistent-store[=<CONSISTENT_STORE_HOST_PORT>]
+        Start a Consistent Store with default host and port: 0.0.0.0:9124. This flag accepts also a port, a host, or both (e.g., 0.0.0.0:9124).
+        
+        When providing a specific value, please use the = sign between the flag and value: `--with-consistent-store=9124` or `--with-consistent-store=0.0.0.0`, or `--with-consistent-store=0.0.0.0:9124` The Consistent Store will be automatically enabled
+        when `--with-graphql` is set.
+
+    --with-graphql[=<GRAPHQL_HOST_PORT>]
+        Start a GraphQL server with default host and port: 0.0.0.0:9125. This flag accepts also a port, a host, or both (e.g., 0.0.0.0:9125).
+        
+        When providing a specific value, please use the = sign between the flag and value: `--with-graphql=9125` or `--with-graphql=0.0.0.0`, or `--with-graphql=0.0.0.0:9125`
+        
+        Note that GraphQL requires a running indexer and consistent store, which will be enabled by default even if those flags are not set.
+
+    --fullnode-rpc-port <FULLNODE_RPC_PORT>
+        Port to start the Fullnode RPC server on. Default port is 9000
+        
+        [default: 9000]
+
+    --epoch-duration-ms <EPOCH_DURATION_MS>
+        Set the epoch duration. Can only be used when `--force-regenesis` flag is passed or if there's no genesis config and one will be auto-generated. When this flag is not set but `--force-regenesis` is set, the epoch duration will be set to 60
+        seconds
+
+    --data-ingestion-dir <DATA_INGESTION_DIR>
+        Make the fullnode dump executed checkpoints as files to this directory. This is incompatible with --no-full-node.
+        
+        If --with-indexer is set, this defaults to a temporary directory.
+
+    --no-full-node
+        Start the network without a fullnode
+
+    --committee-size <COMMITTEE_SIZE>
+        Set the number of validators in the network. If a genesis was already generated with a specific number of validators, this will not override it; the user should recreate the genesis with the desired number of validators
+-h, --help Print help (see more with '--help')
 ```
 
 Use `sui start --help` to see these options in your console.
@@ -201,4 +238,4 @@ To resolve this, switch or update to Node.js 18 and then try again.
 
 ## Test with the Sui TypeScript SDK
 
-The published version of the Sui TypeScript SDK might be an earlier version than the version of Sui you installed for your local network. To make sure you're using the latest version of the SDK, use the `experimental`-tagged version (for example, `0.0.0-experimental-20230317184920`) in the [Current Tags](https://www.npmjs.com/package/@mysten/sui?activeTab=versions) section of the Sui NPM registry.
+The published version of the Sui TypeScript SDK might be an earlier version than the version of Sui you installed for your local network. To make sure you're using the latest version of the SDK, use the `experimental`-tagged version (for example, `0.0.0-experimental-20230317184920`) in the [Current Tags](https://www.npmjs.com/package/@mysten/sui?activeTab=versions) section of the Sui NPM registry.
