Skip to content

Commit

Permalink
Merge branch 'main' into fix/invoke-view-only
Browse files Browse the repository at this point in the history
  • Loading branch information
elizabethengelman authored Nov 7, 2024
2 parents 85cdc33 + 8e1d45b commit 23b8d96
Show file tree
Hide file tree
Showing 13 changed files with 217 additions and 88 deletions.
93 changes: 87 additions & 6 deletions FULL_HELP_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ Anything after the `--` double dash (the "slop") is parsed as arguments to the c
* `events` — Watch the network for contract events
* `env` — Prints the current environment variables or defaults to the stdout, in a format that can be used as .env file. Environment variables have precedency over defaults
* `keys` — Create and manage identities including keys and addresses
* `network` — Start and configure networks
* `network` — Configure connection to networks
* `container` — Start local networks in containers
* `snapshot` — Download a snapshot of a ledger from an archive
* `tx` — Sign, Simulate, and Send transactions
* `xdr` — Decode and encode XDR
Expand Down Expand Up @@ -1105,7 +1106,7 @@ Set the default identity that will be used on all commands. This allows you to s

## `stellar network`

Start and configure networks
Configure connection to networks

**Usage:** `stellar network <COMMAND>`

Expand All @@ -1117,7 +1118,7 @@ Start and configure networks
* `start` — ⚠️ Deprecated: use `stellar container start` instead
* `stop` — ⚠️ Deprecated: use `stellar container stop` instead
* `use` — Set the default network that will be used on all commands. This allows you to skip `--network` or setting a environment variable, while reusing this value in all commands that require it
* `container`Commands to start, stop and get logs for a quickstart container
* `container`⚠️ Deprecated: use `stellar container` instead



Expand Down Expand Up @@ -1245,6 +1246,8 @@ Set the default network that will be used on all commands. This allows you to sk

## `stellar network container`

⚠️ Deprecated: use `stellar container` instead

Commands to start, stop and get logs for a quickstart container

**Usage:** `stellar network container <COMMAND>`
Expand All @@ -1253,7 +1256,7 @@ Commands to start, stop and get logs for a quickstart container

* `logs` — Get logs from a running network container
* `start` — Start a container running a Stellar node, RPC, API, and friendbot (faucet)
* `stop` — Stop a network container started with `network container start`
* `stop` — Stop a network container started with `stellar container start`



Expand All @@ -1277,7 +1280,7 @@ Get logs from a running network container

Start a container running a Stellar node, RPC, API, and friendbot (faucet).

`stellar network container start NETWORK [OPTIONS]`
`stellar container start NETWORK [OPTIONS]`

By default, when starting a testnet container, without any optional arguments, it will run the equivalent of the following docker command:

Expand Down Expand Up @@ -1307,7 +1310,7 @@ By default, when starting a testnet container, without any optional arguments, i

## `stellar network container stop`

Stop a network container started with `network container start`
Stop a network container started with `stellar container start`

**Usage:** `stellar network container stop [OPTIONS] <NAME>`

Expand All @@ -1321,6 +1324,84 @@ Stop a network container started with `network container start`



## `stellar container`

Start local networks in containers

**Usage:** `stellar container <COMMAND>`

###### **Subcommands:**

* `logs` — Get logs from a running network container
* `start` — Start a container running a Stellar node, RPC, API, and friendbot (faucet)
* `stop` — Stop a network container started with `stellar container start`



## `stellar container logs`

Get logs from a running network container

**Usage:** `stellar container logs [OPTIONS] <NAME>`

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

* `<NAME>` — Container to get logs from

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

* `-d`, `--docker-host <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



## `stellar container start`

Start a container running a Stellar node, RPC, API, and friendbot (faucet).

`stellar container start NETWORK [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 rpc,horizon`

**Usage:** `stellar container start [OPTIONS] <NETWORK>`

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

* `<NETWORK>` — Network to start

Possible values: `local`, `testnet`, `futurenet`, `pubnet`


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

* `-d`, `--docker-host <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
* `--name <NAME>` — Optional argument to specify the container name
* `-l`, `--limits <LIMITS>` — Optional argument to specify the limits for the local network only
* `-p`, `--ports-mapping <PORTS_MAPPING>` — Argument to specify the `HOST_PORT:CONTAINER_PORT` mapping

Default value: `8000:8000`
* `-t`, `--image-tag-override <IMAGE_TAG_OVERRIDE>` — Optional argument to override the default docker image tag for the given network
* `--protocol-version <PROTOCOL_VERSION>` — Optional argument to specify the protocol version for the local network only



## `stellar container stop`

Stop a network container started with `stellar container start`

**Usage:** `stellar container stop [OPTIONS] <NAME>`

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

* `<NAME>` — Container to stop

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

* `-d`, `--docker-host <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



## `stellar snapshot`

Download a snapshot of a ledger from an archive
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 23b8d96

Please sign in to comment.