Skip to content

Commit

Permalink
fix: md
Browse files Browse the repository at this point in the history
  • Loading branch information
@willemneal
willemneal committed Apr 30, 2024
1 parent 61e1c61 commit 8389faf
Showing 1 changed file with 0 additions and 346 deletions.
346 changes: 0 additions & 346 deletions docs/soroban-cli-full-docs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,6 @@ This document contains the help content for the `soroban` command-line program.

* [`soroban`↴](#soroban)
* [`soroban completion`↴](#soroban-completion)
* [`soroban config`↴](#soroban-config)
* [`soroban config network`↴](#soroban-config-network)
* [`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)
* [`soroban config identity fund`↴](#soroban-config-identity-fund)
* [`soroban config identity generate`↴](#soroban-config-identity-generate)
* [`soroban config identity ls`↴](#soroban-config-identity-ls)
* [`soroban config identity rm`↴](#soroban-config-identity-rm)
* [`soroban config identity show`↴](#soroban-config-identity-show)
* [`soroban contract`↴](#soroban-contract)
* [`soroban contract asset`↴](#soroban-contract-asset)
* [`soroban contract asset id`↴](#soroban-contract-asset-id)
Expand Down Expand Up @@ -103,7 +88,6 @@ Full CLI reference: https://github.com/stellar/soroban-tools/tree/main/docs/soro
###### **Subcommands:**

* `completion` — Print shell completion code for the specified shell
* `config` — Deprecated, use `soroban keys` and `soroban network` instead
* `contract` — Tools for smart contract developers
* `events` — Watch the network for contract events
* `keys` — Create and manage identities including keys and addresses
Expand Down Expand Up @@ -162,336 +146,6 @@ To enable autocomplete permanently, run:



## `soroban config`

Deprecated, use `soroban keys` and `soroban network` instead

**Usage:** `soroban config <COMMAND>`

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

* `network` — Configure different networks. Depraecated, use `soroban network` instead
* `identity` — Identity management. Deprecated, use `soroban keys` instead



## `soroban config network`

Configure different networks. Depraecated, use `soroban network` instead

**Usage:** `soroban config network <COMMAND>`

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

* `add` — Add a new network
* `rm` — Remove a network
* `ls` — List networks
* `start` — Start network
* `stop` — Stop a network started with `network start`. For example, if you ran `soroban network start local`, you can use `soroban network stop local` to stop it



## `soroban config network add`

Add a new network

**Usage:** `soroban config network add [OPTIONS] --rpc-url <RPC_URL> --network-passphrase <NETWORK_PASSPHRASE> <NAME>`

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

* `<NAME>` — Name of network

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

* `--rpc-url <RPC_URL>` — RPC server endpoint
* `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
* `--global` — Use global config

Possible values: `true`, `false`

* `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."



## `soroban config network rm`

Remove a network

**Usage:** `soroban config network rm [OPTIONS] <NAME>`

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

* `<NAME>` — Network to remove

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

* `--global` — Use global config

Possible values: `true`, `false`

* `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."



## `soroban config network ls`

List networks

**Usage:** `soroban config network ls [OPTIONS]`

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

* `--global` — Use global config

Possible values: `true`, `false`

* `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."
* `-l`, `--long` — Get more info about the networks

Possible values: `true`, `false`




## `soroban config network start`

Start network

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

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

**Usage:** `soroban config network 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
* `-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
* `-v`, `--protocol-version <PROTOCOL_VERSION>` — Optional argument to specify the protocol version for the local network only



## `soroban config network stop`

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

**Usage:** `soroban config network stop [OPTIONS] <NETWORK>`

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

* `<NETWORK>` — Network to stop

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



## `soroban config identity`

Identity management. Deprecated, use `soroban keys` instead

**Usage:** `soroban config identity <COMMAND>`

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

* `add` — Add a new identity (keypair, ledger, macOS keychain)
* `address` — Given an identity return its address (public key)
* `fund` — Fund an identity on a test network
* `generate` — Generate a new identity with a seed phrase, currently 12 words
* `ls` — List identities
* `rm` — Remove an identity
* `show` — Given an identity return its private key



## `soroban config identity add`

Add a new identity (keypair, ledger, macOS keychain)

**Usage:** `soroban config identity add [OPTIONS] <NAME>`

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

* `<NAME>` — Name of identity

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

* `--secret-key` — Add using secret_key Can provide with SOROBAN_SECRET_KEY

Possible values: `true`, `false`

* `--seed-phrase` — Add using 12 word seed phrase to generate secret_key

Possible values: `true`, `false`

* `--global` — Use global config

Possible values: `true`, `false`

* `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."



## `soroban config identity address`

Given an identity return its address (public key)

**Usage:** `soroban config identity address [OPTIONS] <NAME>`

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

* `<NAME>` — Name of identity to lookup, default test identity used if not provided

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

* `--hd-path <HD_PATH>` — If identity is a seed phrase use this hd path, default is 0
* `--global` — Use global config

Possible values: `true`, `false`

* `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."



## `soroban config identity fund`

Fund an identity on a test network

**Usage:** `soroban config identity fund [OPTIONS] <NAME>`

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

* `<NAME>` — Name of identity to lookup, default test identity used if not provided

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

* `--rpc-url <RPC_URL>` — RPC server endpoint
* `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
* `--network <NETWORK>` — Name of network to use from config
* `--hd-path <HD_PATH>` — If identity is a seed phrase use this hd path, default is 0
* `--global` — Use global config

Possible values: `true`, `false`

* `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."



## `soroban config identity generate`

Generate a new identity with a seed phrase, currently 12 words

**Usage:** `soroban config identity generate [OPTIONS] <NAME>`

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

* `<NAME>` — Name of identity

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

* `--no-fund` — Do not fund address

Possible values: `true`, `false`

* `--seed <SEED>` — Optional seed to use when generating seed phrase. Random otherwise
* `-s`, `--as-secret` — Output the generated identity as a secret key

Possible values: `true`, `false`

* `--global` — Use global config

Possible values: `true`, `false`

* `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."
* `--hd-path <HD_PATH>` — When generating a secret key, which hd_path should be used from the original seed_phrase
* `-d`, `--default-seed` — Generate the default seed phrase. Useful for testing. Equivalent to --seed 0000000000000000

Possible values: `true`, `false`

* `--rpc-url <RPC_URL>` — RPC server endpoint
* `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
* `--network <NETWORK>` — Name of network to use from config



## `soroban config identity ls`

List identities

**Usage:** `soroban config identity ls [OPTIONS]`

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

* `--global` — Use global config

Possible values: `true`, `false`

* `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."
* `-l`, `--long`

Possible values: `true`, `false`




## `soroban config identity rm`

Remove an identity

**Usage:** `soroban config identity rm [OPTIONS] <NAME>`

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

* `<NAME>` — Identity to remove

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

* `--global` — Use global config

Possible values: `true`, `false`

* `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."



## `soroban config identity show`

Given an identity return its private key

**Usage:** `soroban config identity show [OPTIONS] <NAME>`

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

* `<NAME>` — Name of identity to lookup, default is test identity

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

* `--hd-path <HD_PATH>` — If identity is a seed phrase use this hd path, default is 0
* `--global` — Use global config

Possible values: `true`, `false`

* `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."



## `soroban contract`

Tools for smart contract developers
Expand Down

0 comments on commit 8389faf

Please sign in to comment.