Skip to content

Commit 2746bd2

Browse files
committed
update gendocs
1 parent 0f8ce3a commit 2746bd2

File tree

8 files changed

+229
-370
lines changed

8 files changed

+229
-370
lines changed

docs/commands/README.md

Lines changed: 8 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,23 @@
22

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

5-
Version: 0.1.4
6-
7-
Arguments:
8-
9-
* `--help`: Print help information
10-
11-
* `--version`: Print version information
5+
Version: 0.1.5
126

137
## Subcommands
148

9+
---
10+
1511
### `beaker new`
1612

1713
Create new workspace from boilerplate
1814

1915
Arguments:
2016

21-
* `--help`: Print help information
17+
* `<NAME>` Workspace name
2218

23-
* `--version`: Print version information
19+
* `-t / --target-dir <TARGET_DIR>`: Path to store generated workspace
2420

25-
* ` <name>`Workspace name
26-
27-
* `-t/--target-dir <target-dir>`: Path to store generated workspace
28-
29-
* `-b/--branch <branch>`: Template's branch, using main if not specified
21+
* `-b / --branch <BRANCH>`: Template's branch, using main if not specified
3022

3123
---
3224

@@ -36,12 +28,6 @@ Manipulating and interacting with CosmWasm contract
3628

3729
[\> `beaker wasm`'s subcommands](./beaker_wasm.md)
3830

39-
Arguments:
40-
41-
* `--help`: Print help information
42-
43-
* `--version`: Print version information
44-
4531
---
4632

4733
### `beaker key`
@@ -50,12 +36,6 @@ Managing key backed by system's secret store
5036

5137
[\> `beaker key`'s subcommands](./beaker_key.md)
5238

53-
Arguments:
54-
55-
* `--help`: Print help information
56-
57-
* `--version`: Print version information
58-
5939
---
6040

6141
### `beaker console`
@@ -64,22 +44,12 @@ Launch interactive console for interacting with the project
6444

6545
Arguments:
6646

67-
* `--help`: Print help information
68-
69-
* `--version`: Print version information
70-
71-
* `-n/--network <network>` (default: `local`)
47+
* `-n / --network <NETWORK>` (default: `local`)
7248

7349
---
7450

7551
### `beaker task`
7652

7753
Managing tasks for the project
7854

79-
[\> `beaker task`'s subcommands](./beaker_task.md)
80-
81-
Arguments:
82-
83-
* `--help`: Print help information
84-
85-
* `--version`: Print version information
55+
[\> `beaker task`'s subcommands](./beaker_task.md)

docs/commands/beaker_key.md

Lines changed: 11 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,21 @@
22

33
Managing key backed by system's secret store
44

5-
Arguments:
6-
7-
* `--help`: Print help information
8-
9-
* `--version`: Print version information
10-
115
## Subcommands
126

7+
---
8+
139
### `beaker key set`
1410

1511
Create new key or update existing key
1612

1713
Arguments:
1814

19-
* `--help`: Print help information
20-
21-
* `--version`: Print version information
15+
* `<NAME>` Name of the key to create or update
2216

23-
* ` <name>`Name of the key to create or update
17+
* `<MNEMONIC>` Mnemonic string to store as an entry
2418

25-
* ` <mnemonic>`Mnemonic string to store as an entry
26-
27-
* `-y/--yes`: Agree to all prompts
19+
* `-y / --yes <YES>`: Agree to all prompts
2820

2921
---
3022

@@ -34,13 +26,9 @@ Delete existing key
3426

3527
Arguments:
3628

37-
* `--help`: Print help information
38-
39-
* `--version`: Print version information
29+
* `<NAME>` Name of the key to create or update
4030

41-
* ` <name>`Name of the key to create or update
42-
43-
* `-y/--yes`: Agree to all prompts
31+
* `-y / --yes <YES>`: Agree to all prompts
4432

4533
---
4634

@@ -50,11 +38,7 @@ Get address from keyring's stored key
5038

5139
Arguments:
5240

53-
* `--help`: Print help information
54-
55-
* `--version`: Print version information
56-
57-
* ` <name>`Name of the key to create or update
41+
* `<NAME>` Name of the key to create or update
5842

5943
---
6044

@@ -64,12 +48,8 @@ Generate new mnemonic
6448

6549
Arguments:
6650

67-
* `--help`: Print help information
68-
69-
* `--version`: Print version information
70-
71-
* ` <name>`Name of the key to create or update
51+
* `<NAME>` Name of the key to create or update
7252

73-
* `--show`: Show mnemonic in the console if set, keep it secret otherwise
53+
* `--show <SHOW>`: Show mnemonic in the console if set, keep it secret otherwise
7454

75-
* `-y/--yes`: Agree to all prompts
55+
* `-y / --yes <YES>`: Agree to all prompts

docs/commands/beaker_task.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,17 @@
22

33
Managing tasks for the project
44

5-
Arguments:
6-
7-
* `--help`: Print help information
8-
9-
* `--version`: Print version information
10-
115
## Subcommands
126

7+
---
8+
139
### `beaker task new`
1410

1511
Create a new task
1612

1713
Arguments:
1814

19-
* `--help`: Print help information
20-
21-
* `--version`: Print version information
22-
23-
* ` <task>`Name of the task
15+
* `<TASK>` Name of the task
2416

2517
---
2618

@@ -30,10 +22,6 @@ Run a task
3022

3123
Arguments:
3224

33-
* `--help`: Print help information
34-
35-
* `--version`: Print version information
36-
37-
* ` <script>`Name of the task
25+
* `<SCRIPT>` Name of the task
3826

39-
* ` <args>`
27+
* `<ARGS>`

0 commit comments

Comments
 (0)