Skip to content

Commit 1a52ea1

Browse files
authored
Merge pull request #165 from onflow/docs-command-syntax
Docs: fixed command syntax
2 parents c4e746e + e231e2a commit 1a52ea1

File tree

10 files changed

+28
-11
lines changed

10 files changed

+28
-11
lines changed

docs/account-staking-info.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ description: How to get staking info
66

77
Retrieve staking information for the account on the Flow network using Flow CLI.
88

9-
`flow accounts staking-info <address>`
9+
```shell
10+
flow accounts staking-info <address>
11+
```
1012

1113
## Example Usage
1214

docs/generate-keys.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ description: How to generate key pair from the command line
77
The Flow CLI provides a command to generate ECDSA key pairs
88
that can be [attached to new or existing Flow accounts](https://docs.onflow.org/concepts/accounts-and-keys).
99

10-
`flow keys generate`
10+
```shell
11+
flow keys generate
12+
```
1113

1214
⚠️ Store private key safely and don't share with anyone!
1315

docs/get-accounts.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ description: How to get a Flow account from the command line
66

77
The Flow CLI provides a command to fetch any account by its address from the Flow network.
88

9-
`flow accounts get <address>`
10-
9+
```shell
10+
flow accounts get <address>
11+
```
1112

1213
## Example Usage
1314

docs/get-blocks.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ description: How to get a block from the command line
66

77
The Flow CLI provides a command to fetch any block from the Flow network.
88

9-
`flow blocks get <block_id|latest|block_height>`
9+
```shell
10+
flow blocks get <block_id|latest|block_height>
11+
```
1012

1113
## Example Usage
1214

docs/get-collections.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ description: How to get a collection from the command line
66

77
The Flow CLI provides a command to fetch any collection from the Flow network.
88

9-
`flow collections get <collection_id>`
9+
```shell
10+
flow collections get <collection_id>
11+
```
1012

1113
## Example Usage
1214

docs/get-events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Events can be requested for a specific sealed block range via the
1010
start and end block height fields and further filtered by event name.
1111

1212
```shell
13-
flow events get <event_name> <block_height_range_start> <optional:block_height_range_end|latest>`
13+
flow events get <event_name> <block_height_range_start> <optional:block_height_range_end|latest>
1414
```
1515

1616
## Example Usage

docs/get-transactions.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ description: How to get a Flow transaction from the command line
77
The Flow CLI provides a command to fetch a transaction
88
that was previously submitted to an Access API.
99

10-
`flow transactions get <tx_id>`
10+
```shell
11+
flow transactions get <tx_id>
12+
```
1113

1214
## Example Usage
1315

docs/send-transactions.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ description: How to send a Flow transaction from the command line
77
The Flow CLI provides a command to sign and send transactions to
88
any Flow Access API.
99

10-
`flow transactions send`
10+
```shell
11+
flow transactions send
12+
```
1113

1214
## Example Usage
1315

docs/start-emulator.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ description: How to start Flow emulator from the command line
77
The Flow CLI provides a command to start an emulator.
88
The Flow Emulator is a lightweight tool that emulates the behaviour of the real Flow network.
99

10-
`flow emulator`
10+
```shell
11+
flow emulator
12+
```
1113

1214
⚠️ The emulator command expects configuration to be initialized. See [flow init](https://docs.onflow.org/flow-cli/initialize-configuration/) command.
1315

docs/template.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ description:
66

77
{short description}
88

9-
`{command}`
9+
```shell
10+
{command}
11+
```
1012

1113
{optional warning}
1214

0 commit comments

Comments
 (0)