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 0130df1 commit 3367c27
Showing 1 changed file with 23 additions and 22 deletions.
45 changes: 23 additions & 22 deletions docs/soroban-cli-full-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ This document contains the help content for the `soroban` command-line program.
* [`soroban contract id`](#soroban-contract-id)
* [`soroban contract id asset`](#soroban-contract-id-asset)
* [`soroban contract id wasm`](#soroban-contract-id-wasm)
* [`soroban contract init`](#soroban-contract-init)
* [`soroban contract inspect`](#soroban-contract-inspect)
* [`soroban contract install`](#soroban-contract-install)
* [`soroban contract invoke`](#soroban-contract-invoke)
Expand All @@ -49,7 +50,6 @@ This document contains the help content for the `soroban` command-line program.
* [`soroban keys ls`](#soroban-keys-ls)
* [`soroban keys rm`](#soroban-keys-rm)
* [`soroban keys show`](#soroban-keys-show)
* [`soroban init`](#soroban-init)
* [`soroban lab`](#soroban-lab)
* [`soroban lab token`](#soroban-lab-token)
* [`soroban lab token wrap`](#soroban-lab-token-wrap)
Expand Down Expand Up @@ -103,7 +103,6 @@ Full CLI reference: https://github.com/stellar/soroban-tools/tree/main/docs/soro
* `contract` — Tools for smart contract developers
* `events` — Watch the network for contract events
* `keys` — Create and manage identities including keys and addresses
* `init` — Initialize a new Soroban project
* `lab` — Experiment with early features and expert tools
* `network` — Start and configure networks
* `version` — Print version information
Expand Down Expand Up @@ -386,6 +385,7 @@ Tools for smart contract developers
* `deploy` — Deploy a wasm contract
* `fetch` — Fetch a contract's Wasm binary
* `id` — Generate the contract id for a given contract or asset
* `init` — Initialize a Soroban project with an example contract
* `inspect` — Inspect a WASM file listing contract functions, meta, etc
* `install` — Install a WASM file to the ledger without creating a contract instance
* `invoke` — Invoke a contract function
Expand Down Expand Up @@ -668,6 +668,27 @@ Deploy normal Wasm Contract



## `soroban contract init`

Initialize a Soroban project with an example contract

**Usage:** `soroban contract init [OPTIONS] <PROJECT_PATH>`

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

* `<PROJECT_PATH>`

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

* `-w`, `--with-example <WITH_EXAMPLE>` — optional flag to specify soroban example contracts to include

Default value: `none`

Possible values: `account`, `alloc`, `atomic-multiswap`, `atomic-swap`, `auth`, `cross-contract`, `custom-types`, `deep-contract-auth`, `deployer`, `errors`, `events`, `fuzzing`, `hello-world`, `increment`, `liquidity-pool`, `logging`, `simple-account`, `single-offer`, `timelock`, `token`, `upgradeable-contract`, `none`




## `soroban contract inspect`

Inspect a WASM file listing contract functions, meta, etc
Expand Down Expand Up @@ -1034,26 +1055,6 @@ Given an identity return its private key
* `--config-dir <CONFIG_DIR>` — Location of config directory, default is "."


## `soroban init`

Initialize a new Soroban project

**Usage:** `soroban init [OPTIONS] <PROJECT_PATH>`

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

* `<PROJECT_PATH>`

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

* `-w`, `--with-contract <WITH_CONTRACT>` — optional flag to specify soroban example contracts to include

Default value: `none`

Possible values: `account`, `alloc`, `atomic-multiswap`, `atomic-swap`, `auth`, `cross-contract`, `custom-types`, `deep-contract-auth`, `deployer`, `errors`, `events`, `fuzzing`, `hello-world`, `increment`, `liquidity-pool`, `logging`, `simple-account`, `single-offer`, `timelock`, `token`, `upgradeable-contract`, `none`




## `soroban lab`

Expand Down

0 comments on commit 3367c27

Please sign in to comment.