Skip to content

Commit 8b7aabb

Browse files
committed
doc: add rust cli docs
1 parent bbe0db5 commit 8b7aabb

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

docs/install.md

+18-5
Original file line numberDiff line numberDiff line change
@@ -70,14 +70,27 @@ cd warnet
7070

7171
## Install Warnet
7272

73-
### Optional: use a virtual Python environment such as `venv`
73+
The Warnet server and cli tool need to be installed using PIP:
7474

75-
```bash
76-
python3 -m venv .venv # Use alternative venv manager if desired
77-
source .venv/bin/activate
78-
```
75+
> [!TIP]
76+
> Use a python virtual environment such as venv
77+
> ```bash
78+
> python3 -m venv .venv # Use alternative venv manager if desired
79+
> source .venv/bin/activate
80+
> ```
7981
8082
```bash
8183
pip install --upgrade pip
8284
pip install -e .
8385
```
86+
87+
### Experimental Rust cli tool
88+
89+
There is an experimental Rust cli tool which can be built using `cargo`:
90+
91+
```bash
92+
# build
93+
cargo build
94+
# Run
95+
./target/debug/warcli help
96+
```

0 commit comments

Comments
 (0)