Skip to content

Commit

Permalink
Move doc comments to be displayed as help for network start
Browse files Browse the repository at this point in the history
  • Loading branch information
elizabethengelman committed Feb 7, 2024
1 parent f36e676 commit 57790a4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 11 deletions.
6 changes: 6 additions & 0 deletions cmd/soroban-cli/src/commands/network/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ pub enum Cmd {
/// List networks
Ls(ls::Cmd),
/// Start network
///
/// This command allows for starting a stellar quickstart container. To run it, you can use the following command:
/// `soroban network 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-soroban-rpc
Start(start::Cmd),
/// Stop network
Stop(stop::Cmd),
Expand Down
11 changes: 0 additions & 11 deletions cmd/soroban-cli/src/commands/network/start.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,6 @@ const API_DEFAULT_VERSION: &ClientVersion = &ClientVersion {
minor_version: 40,
};

/// This command allows for starting a stellar quickstart container. To run it, you can use the following command:
/// `soroban network start <NETWORK> [OPTIONS] -- [DOCKER_RUN_ARGS]`
///
/// `DOCKER_RUN_ARGS`: These are arguments to be passed to the `docker run` command itself, and should be passed in after the slop `--`. Some common options are:
/// -p <`FROM_PORT`>:<`TO_PORT`> - this maps the port from the container to the host machine. By default, the port is 8000.
/// -d - this runs the container in detached mode, so that it runs in the background
// By default, without any optional arguments, the following docker command will run:
// docker run --rm -p 8000:8000 --name stellar stellar/quickstart:testing --testnet --enable-soroban-rpc

#[derive(Debug, clap::Parser, Clone)]
pub struct Cmd {
/// Network to start, e.g. local, testnet, futurenet, pubnet
Expand Down

0 comments on commit 57790a4

Please sign in to comment.