From 201a1de05c76185e5229fd2fa4d7beeaee1bfc32 Mon Sep 17 00:00:00 2001 From: Elizabeth Engelman <4752801+elizabethengelman@users.noreply.github.com> Date: Fri, 12 Jan 2024 17:05:25 -0500 Subject: [PATCH] Add generated docs --- docs/soroban-cli-full-docs.md | 72 +++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) diff --git a/docs/soroban-cli-full-docs.md b/docs/soroban-cli-full-docs.md index 3546594c61..ae5e8a82f0 100644 --- a/docs/soroban-cli-full-docs.md +++ b/docs/soroban-cli-full-docs.md @@ -11,6 +11,8 @@ This document contains the help content for the `soroban` command-line program. * [`soroban config network add`↴](#soroban-config-network-add) * [`soroban config network rm`↴](#soroban-config-network-rm) * [`soroban config network ls`↴](#soroban-config-network-ls) +* [`soroban config network start`↴](#soroban-config-network-start) +* [`soroban config network stop`↴](#soroban-config-network-stop) * [`soroban config identity`↴](#soroban-config-identity) * [`soroban config identity add`↴](#soroban-config-identity-add) * [`soroban config identity address`↴](#soroban-config-identity-address) @@ -64,6 +66,8 @@ This document contains the help content for the `soroban` command-line program. * [`soroban network add`↴](#soroban-network-add) * [`soroban network rm`↴](#soroban-network-rm) * [`soroban network ls`↴](#soroban-network-ls) +* [`soroban network start`↴](#soroban-network-start) +* [`soroban network stop`↴](#soroban-network-stop) * [`soroban version`↴](#soroban-version) ## `soroban` @@ -166,6 +170,8 @@ Configure different networks. Depraecated, use `soroban network` instead * `add` — Add a new network * `rm` — Remove a network * `ls` — List networks +* `start` — Start network +* `stop` — Stop network @@ -219,6 +225,38 @@ List networks +## `soroban config network start` + +Start network + +**Usage:** `soroban config network start [OPTIONS] [-- ...]` + +###### **Arguments:** + +* `` — Network to start, e.g. local, testnet, futurenet, pubnet +* `` + +###### **Options:** + +* `-t`, `--image-tag-override ` — optional argument to override the default docker image tag for the given network +* `-r`, `--disable-soroban-rpc` — optional argument to turn off soroban rpc +* `-p`, `--protocol-version ` +* `-l`, `--limit ` + + + +## `soroban config network stop` + +Stop network + +**Usage:** `soroban config network stop [CONTAINER]` + +###### **Arguments:** + +* `` — docker container to stop, defaults to "stellar" + + + ## `soroban config identity` Identity management. Deprecated, use `soroban keys` instead @@ -1257,6 +1295,8 @@ Start and configure networks * `add` — Add a new network * `rm` — Remove a network * `ls` — List networks +* `start` — Start network +* `stop` — Stop network @@ -1310,6 +1350,38 @@ List networks +## `soroban network start` + +Start network + +**Usage:** `soroban network start [OPTIONS] [-- ...]` + +###### **Arguments:** + +* `` — Network to start, e.g. local, testnet, futurenet, pubnet +* `` + +###### **Options:** + +* `-t`, `--image-tag-override ` — optional argument to override the default docker image tag for the given network +* `-r`, `--disable-soroban-rpc` — optional argument to turn off soroban rpc +* `-p`, `--protocol-version ` +* `-l`, `--limit ` + + + +## `soroban network stop` + +Stop network + +**Usage:** `soroban network stop [CONTAINER]` + +###### **Arguments:** + +* `` — docker container to stop, defaults to "stellar" + + + ## `soroban version` Print version information