Skip to content

Commit

Permalink
Add generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
elizabethengelman committed Jan 12, 2024
1 parent af584c2 commit 201a1de
Showing 1 changed file with 72 additions and 0 deletions.
72 changes: 72 additions & 0 deletions docs/soroban-cli-full-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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



Expand Down Expand Up @@ -219,6 +225,38 @@ List networks



## `soroban config network start`

Start network

**Usage:** `soroban config network start [OPTIONS] <NETWORK> [-- <DOCKER_RUN_ARGS>...]`

###### **Arguments:**

* `<NETWORK>` — Network to start, e.g. local, testnet, futurenet, pubnet
* `<DOCKER_RUN_ARGS>`

###### **Options:**

* `-t`, `--image-tag-override <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 <PROTOCOL_VERSION>`
* `-l`, `--limit <LIMIT>`



## `soroban config network stop`

Stop network

**Usage:** `soroban config network stop [CONTAINER]`

###### **Arguments:**

* `<CONTAINER>` — docker container to stop, defaults to "stellar"



## `soroban config identity`

Identity management. Deprecated, use `soroban keys` instead
Expand Down Expand Up @@ -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



Expand Down Expand Up @@ -1310,6 +1350,38 @@ List networks



## `soroban network start`

Start network

**Usage:** `soroban network start [OPTIONS] <NETWORK> [-- <DOCKER_RUN_ARGS>...]`

###### **Arguments:**

* `<NETWORK>` — Network to start, e.g. local, testnet, futurenet, pubnet
* `<DOCKER_RUN_ARGS>`

###### **Options:**

* `-t`, `--image-tag-override <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 <PROTOCOL_VERSION>`
* `-l`, `--limit <LIMIT>`



## `soroban network stop`

Stop network

**Usage:** `soroban network stop [CONTAINER]`

###### **Arguments:**

* `<CONTAINER>` — docker container to stop, defaults to "stellar"



## `soroban version`

Print version information
Expand Down

0 comments on commit 201a1de

Please sign in to comment.