From 6637872e33694b1e3d4c4dc97d4722007440e53c Mon Sep 17 00:00:00 2001 From: Elizabeth Engelman <4752801+elizabethengelman@users.noreply.github.com> Date: Thu, 22 Feb 2024 13:49:45 -0500 Subject: [PATCH] Update auto generated docs --- docs/soroban-cli-full-docs.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/docs/soroban-cli-full-docs.md b/docs/soroban-cli-full-docs.md index c2a8932bc..61d5fe944 100644 --- a/docs/soroban-cli-full-docs.md +++ b/docs/soroban-cli-full-docs.md @@ -187,7 +187,7 @@ Configure different networks. Depraecated, use `soroban network` instead * `rm` — Remove a network * `ls` — List networks * `start` — Start network -* `stop` — Stop network +* `stop` — Stop a network started with `network start`. For example, if you ran `soroban network start local`, you can use `soroban network stop local` to stop it @@ -257,7 +257,9 @@ List networks Start network -This command allows for starting a stellar quickstart container. To run it, you can use the following command: `soroban network start [OPTIONS]` +Start a container running a Stellar node, RPC, API, and friendbot (faucet). + +soroban network start [OPTIONS] By default, when starting a testnet container, without any optional arguments, it will run the equivalent of the following docker command: docker run --rm -p 8000:8000 --name stellar stellar/quickstart:testing --testnet --enable-soroban-rpc @@ -272,12 +274,11 @@ By default, when starting a testnet container, without any optional arguments, i ###### **Options:** -* `-d`, `--docker-socket-path ` — Optional argument to override the default docker socket path. This is useful when you are using a non-standard docker socket path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock -* `-l`, `--limit ` — Optional argument to specify the limits for the local network only +* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +* `-l`, `--limits ` — Optional argument to specify the limits for the local network only * `-p`, `--ports-mapping ` — Argument to specify the HOST_PORT:CONTAINER_PORT mapping Default value: `8000:8000` -* `-r`, `--disable-soroban-rpc` — Optional argument to turn off soroban rpc * `-t`, `--image-tag-override ` — Optional argument to override the default docker image tag for the given network * `-v`, `--protocol-version ` — Optional argument to specify the protocol version for the local network only @@ -285,7 +286,7 @@ By default, when starting a testnet container, without any optional arguments, i ## `soroban config network stop` -Stop network +Stop a network started with `network start`. For example, if you ran `soroban network start local`, you can use `soroban network stop local` to stop it **Usage:** `soroban config network stop [OPTIONS] ` @@ -298,7 +299,7 @@ Stop network ###### **Options:** -* `-d`, `--docker-socket-path ` — Optional argument to override the default docker socket path. This is useful when you are using a non-standard docker socket path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock @@ -1528,7 +1529,7 @@ Start and configure networks * `rm` — Remove a network * `ls` — List networks * `start` — Start network -* `stop` — Stop network +* `stop` — Stop a network started with `network start`. For example, if you ran `soroban network start local`, you can use `soroban network stop local` to stop it @@ -1598,7 +1599,9 @@ List networks Start network -This command allows for starting a stellar quickstart container. To run it, you can use the following command: `soroban network start [OPTIONS]` +Start a container running a Stellar node, RPC, API, and friendbot (faucet). + +soroban network start [OPTIONS] By default, when starting a testnet container, without any optional arguments, it will run the equivalent of the following docker command: docker run --rm -p 8000:8000 --name stellar stellar/quickstart:testing --testnet --enable-soroban-rpc @@ -1613,12 +1616,11 @@ By default, when starting a testnet container, without any optional arguments, i ###### **Options:** -* `-d`, `--docker-socket-path ` — Optional argument to override the default docker socket path. This is useful when you are using a non-standard docker socket path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock -* `-l`, `--limit ` — Optional argument to specify the limits for the local network only +* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +* `-l`, `--limits ` — Optional argument to specify the limits for the local network only * `-p`, `--ports-mapping ` — Argument to specify the HOST_PORT:CONTAINER_PORT mapping Default value: `8000:8000` -* `-r`, `--disable-soroban-rpc` — Optional argument to turn off soroban rpc * `-t`, `--image-tag-override ` — Optional argument to override the default docker image tag for the given network * `-v`, `--protocol-version ` — Optional argument to specify the protocol version for the local network only @@ -1626,7 +1628,7 @@ By default, when starting a testnet container, without any optional arguments, i ## `soroban network stop` -Stop network +Stop a network started with `network start`. For example, if you ran `soroban network start local`, you can use `soroban network stop local` to stop it **Usage:** `soroban network stop [OPTIONS] ` @@ -1639,7 +1641,7 @@ Stop network ###### **Options:** -* `-d`, `--docker-socket-path ` — Optional argument to override the default docker socket path. This is useful when you are using a non-standard docker socket path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock