You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -111,25 +111,25 @@ pip install -e .
111
111
112
112
## Running
113
113
114
-
Warnet runs a daemon called `warnetd`which can be used to manage multiple warnets.
115
-
`warnetd` will by default log to a file `$XDG_STATE_HOME/warnet/warnet.log` if the `$XDG_STATE_HOME` environment variable is set, otherwise it will use `$HOME/.warnet/warnet.log`.
114
+
Warnet runs a daemon which can be used to manage multiple warnets.
115
+
`warnet` will by default log to a file `$XDG_STATE_HOME/warnet/warnet.log` if the `$XDG_STATE_HOME` environment variable is set, otherwise it will use `$HOME/.warnet/warnet.log`.
116
116
117
-
To start `warnetd` with your venv activated simply run:
117
+
To start `warnet` in the foreground with your venv activated simply run:
118
118
119
119
```bash
120
-
warnetd
120
+
warnet
121
121
```
122
122
123
123
> [!NOTE]
124
-
> `warnetd` also accepts a `--no-debug` option which prevents daemonization
124
+
> `warnetd` also accepts a `--daemon` option which runs the process in the background.
125
125
126
-
Once `warnetd` is running it can be interacted with using the cli tool `warcli`.
127
-
Run `warnet --help` to see a list of possible commands.
126
+
Run `warnet --help` to see a list of options.
128
127
129
-
All `warnet` commands accept a `--network` option, which allows you to specify the warnet you want to control.
128
+
Once `warnet` is running it can be interacted with using the cli tool `warcli`.
129
+
All `warcli` commands accept a `--network` option, which allows you to specify the warnet you want to control.
130
130
This is set by default to `--network="warnet"` to simplify default operation.
131
131
132
-
To start an example warnet, with your venv active, run the following command to use the default graph and network:
132
+
To start an example warnet, with your venv active and the server running, run the following command to use the default graph and network:
133
133
134
134
```bash
135
135
warcli start
@@ -147,7 +147,7 @@ warcli help networks
147
147
148
148
Each container is a node as described in the graph, along with various data exporters and a demo grafana dashboard.
149
149
150
-
The commands listed in `warnet --help` can then be used to control and query the nodes.
150
+
The commands listed in `warcli help` can then be used to control and query the nodes.
151
151
152
152
### Run scenarios on a network
153
153
@@ -163,7 +163,7 @@ To see available scenarios (loaded from the default directory):
163
163
warcli scenarios list
164
164
```
165
165
166
-
Once a scenarios is selected it can be run with `warnet scenarios run <scenario_name> [--network=warnet]`, e.g.:
166
+
Once a scenarios is selected it can be run with `warcli scenarios run <scenario_name> [--network=warnet]`, e.g.:
167
167
168
168
```bash
169
169
# Command one node to generate a wallet and fill 100 blocks with 100 txs each
@@ -177,7 +177,7 @@ This will run the run the scenario in the background until it exits or is killed
177
177
Currently the warnet can be stopped, but **not** stopped, persisted and continued.
0 commit comments