Skip to content

Commit 2f77d25

Browse files
committed
Add installation
1 parent 6c77787 commit 2f77d25

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

docs/build/tools/emulator/index.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,19 @@ sidebar_position: 3
66

77
The Flow Emulator is a lightweight tool that emulates the behavior of the real Flow network for local development and testing.
88

9+
## Installation
10+
11+
The emulator is included with the [Flow CLI](../flow-cli/index.md). Follow the [installation guide](../flow-cli/install.md) to get started.
12+
913
## Quick Start
1014

11-
Start the Flow Emulator with the CLI:
15+
First, create a `flow.json` configuration file:
16+
17+
```bash
18+
flow init --config-only
19+
```
20+
21+
Then start the Flow Emulator:
1222

1323
```bash
1424
flow emulator
@@ -32,15 +42,13 @@ flow emulator --block-time 1s
3242
flow emulator --persist
3343
```
3444

45+
For all available options, see the [CLI commands overview](../flow-cli/index.md).
46+
3547
## Debugging & Testing
3648

3749
- **Code Coverage**: Add `--coverage-reporting` flag and visit `http://localhost:8080/emulator/codeCoverage`
3850
- **Debugging**: Use `#debugger()` pragma in Cadence code for breakpoints
3951

40-
## Installation
41-
42-
The emulator is included with the [Flow CLI](../flow-cli/index.md). Follow the [installation guide](../flow-cli/install.md) to get started.
43-
4452
## Additional Resources
4553

4654
For advanced configuration options, see the [Flow Emulator repository](https://github.com/onflow/flow-emulator/).

0 commit comments

Comments
 (0)