Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
iboss-ptk committed Mar 21, 2023
1 parent 64baed2 commit 85f66cd
Show file tree
Hide file tree
Showing 4 changed files with 78 additions and 3 deletions.
18 changes: 16 additions & 2 deletions docs/commands/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

CosmWasm swiss-army knife configured for Osmosis by default, but trivial to make it work for other CosmWasm enabled chain.

Version: 0.1.3
Version: 0.1.4

Arguments:

Expand Down Expand Up @@ -68,4 +68,18 @@ Arguments:

* `--version`: Print version information

* `-n/--network <network>` (default: `local`)
* `-n/--network <network>` (default: `local`)

---

### `beaker task`

Managing tasks for the project

[\> `beaker task`'s subcommands](./beaker_task.md)

Arguments:

* `--help`: Print help information

* `--version`: Print version information
39 changes: 39 additions & 0 deletions docs/commands/beaker_task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# `beaker task`

Managing tasks for the project

Arguments:

* `--help`: Print help information

* `--version`: Print version information

## Subcommands

### `beaker task new`

Create a new task

Arguments:

* `--help`: Print help information

* `--version`: Print version information

* ` <task>`Name of the task

---

### `beaker task run`

Run a task

Arguments:

* `--help`: Print help information

* `--version`: Print version information

* ` <script>`Name of the task

* ` <args>`
20 changes: 19 additions & 1 deletion docs/commands/beaker_wasm.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ Arguments:

* `-t/--timeout-height <timeout-height>`: Specifies a block timeout height to prevent the tx from being committed past a certain height (default: `0`)

* `-a/--account-sequence <account-sequence>`: Account sequence number to use for the transaction, if not provided, sequence will be fetched from the chain. This is useful if there is an account sequence mismatch

---

### `beaker wasm ts-gen`
Expand Down Expand Up @@ -128,6 +130,8 @@ Arguments:

* `-t/--timeout-height <timeout-height>`: Specifies a block timeout height to prevent the tx from being committed past a certain height (default: `0`)

* `-a/--account-sequence <account-sequence>`: Account sequence number to use for the transaction, if not provided, sequence will be fetched from the chain. This is useful if there is an account sequence mismatch

---

### `beaker wasm clear-admin`
Expand Down Expand Up @@ -160,6 +164,8 @@ Arguments:

* `-t/--timeout-height <timeout-height>`: Specifies a block timeout height to prevent the tx from being committed past a certain height (default: `0`)

* `-a/--account-sequence <account-sequence>`: Account sequence number to use for the transaction, if not provided, sequence will be fetched from the chain. This is useful if there is an account sequence mismatch

---

### `beaker wasm instantiate`
Expand Down Expand Up @@ -202,6 +208,8 @@ Arguments:

* `-t/--timeout-height <timeout-height>`: Specifies a block timeout height to prevent the tx from being committed past a certain height (default: `0`)

* `-a/--account-sequence <account-sequence>`: Account sequence number to use for the transaction, if not provided, sequence will be fetched from the chain. This is useful if there is an account sequence mismatch

---

### `beaker wasm migrate`
Expand Down Expand Up @@ -240,6 +248,8 @@ Arguments:

* `-t/--timeout-height <timeout-height>`: Specifies a block timeout height to prevent the tx from being committed past a certain height (default: `0`)

* `-a/--account-sequence <account-sequence>`: Account sequence number to use for the transaction, if not provided, sequence will be fetched from the chain. This is useful if there is an account sequence mismatch

---

### `beaker wasm deploy`
Expand Down Expand Up @@ -284,6 +294,8 @@ Arguments:

* `-t/--timeout-height <timeout-height>`: Specifies a block timeout height to prevent the tx from being committed past a certain height (default: `0`)

* `-a/--account-sequence <account-sequence>`: Account sequence number to use for the transaction, if not provided, sequence will be fetched from the chain. This is useful if there is an account sequence mismatch

---

### `beaker wasm upgrade`
Expand Down Expand Up @@ -324,6 +336,8 @@ Arguments:

* `-t/--timeout-height <timeout-height>`: Specifies a block timeout height to prevent the tx from being committed past a certain height (default: `0`)

* `-a/--account-sequence <account-sequence>`: Account sequence number to use for the transaction, if not provided, sequence will be fetched from the chain. This is useful if there is an account sequence mismatch

---

### `beaker wasm proposal`
Expand Down Expand Up @@ -372,6 +386,8 @@ Arguments:

* `-t/--timeout-height <timeout-height>`: Specifies a block timeout height to prevent the tx from being committed past a certain height (default: `0`)

* `-a/--account-sequence <account-sequence>`: Account sequence number to use for the transaction, if not provided, sequence will be fetched from the chain. This is useful if there is an account sequence mismatch

---

### `beaker wasm query`
Expand Down Expand Up @@ -404,4 +420,6 @@ Arguments:

* `--signer-private-key <signer-private-key>`: Specifies private_key as a tx signer (base64 encoded string)

* `-t/--timeout-height <timeout-height>`: Specifies a block timeout height to prevent the tx from being committed past a certain height (default: `0`)
* `-t/--timeout-height <timeout-height>`: Specifies a block timeout height to prevent the tx from being committed past a certain height (default: `0`)

* `-a/--account-sequence <account-sequence>`: Account sequence number to use for the transaction, if not provided, sequence will be fetched from the chain. This is useful if there is an account sequence mismatch
4 changes: 4 additions & 0 deletions docs/commands/beaker_wasm_proposal.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ Arguments:

* `-t/--timeout-height <timeout-height>`: Specifies a block timeout height to prevent the tx from being committed past a certain height (default: `0`)

* `-a/--account-sequence <account-sequence>`: Account sequence number to use for the transaction, if not provided, sequence will be fetched from the chain. This is useful if there is an account sequence mismatch

---

### `beaker wasm proposal vote`
Expand Down Expand Up @@ -84,6 +86,8 @@ Arguments:

* `-t/--timeout-height <timeout-height>`: Specifies a block timeout height to prevent the tx from being committed past a certain height (default: `0`)

* `-a/--account-sequence <account-sequence>`: Account sequence number to use for the transaction, if not provided, sequence will be fetched from the chain. This is useful if there is an account sequence mismatch

---

### `beaker wasm proposal query`
Expand Down

0 comments on commit 85f66cd

Please sign in to comment.