Skip to content

Commit

Permalink
Update the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
elizabethengelman committed Jul 16, 2024
1 parent d21365a commit 7d66733
Showing 1 changed file with 13 additions and 27 deletions.
40 changes: 13 additions & 27 deletions FULL_HELP_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -1073,8 +1073,8 @@ By default, when starting a testnet container, without any optional arguments, i

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

* `-c`, `--container-name <CONTAINER_NAME>` — Optional argument to specify the container name
* `-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

Expand All @@ -1090,18 +1090,14 @@ By default, when starting a testnet container, without any optional arguments, i

Stop a network started with `network start`. For example, if you ran `stellar network start local`, you can use `stellar network stop local` to stop it.

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

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

* `<NETWORK>` — Network to stop (used in container name generation)

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

* `<NAME>` — Container to stop

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

* `-c`, `--container-name <CONTAINER_NAME>` — Optional argument to specify the container name
* `-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


Expand All @@ -1114,36 +1110,30 @@ Commands to start, stop and get logs for a quickstart container

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

* `logs`Tail logs of a running network container
* `start` — Start network
* `stop` — Stop a network started with `network container start`. For example, if you ran `network container start local`, you can use `network container stop local` to stop it
* `logs`Get logs of 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`



## `stellar network container logs`

Tail logs of a running network container
Get logs of a running network container

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

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

* `<NETWORK>` — Network container to tail (used in container name generation)

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

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

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

* `-c`, `--container-name <CONTAINER_NAME>` — Optional argument to specify the container name
* `-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 network container start`

Start network

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

`stellar network container start NETWORK [OPTIONS]`
Expand All @@ -1163,8 +1153,8 @@ By default, when starting a testnet container, without any optional arguments, i

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

* `-c`, `--container-name <CONTAINER_NAME>` — Optional argument to specify the container name
* `-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

Expand All @@ -1176,20 +1166,16 @@ By default, when starting a testnet container, without any optional arguments, i

## `stellar network container stop`

Stop a network started with `network container start`. For example, if you ran `network container start local`, you can use `network container stop local` to stop it
Stop a network container started with `network container start`

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

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

* `<NETWORK>` — Network to stop (used in container name generation)

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

* `<NAME>` — Container to stop

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

* `-c`, `--container-name <CONTAINER_NAME>` — Optional argument to specify the container name
* `-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


Expand Down

0 comments on commit 7d66733

Please sign in to comment.