aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordiogo464 <[email protected]>2025-06-30 10:34:16 +0100
committerdiogo464 <[email protected]>2025-06-30 10:34:16 +0100
commitc1d2c4d643bb874b3f974d814750d424db616ccd (patch)
treeffd258c45809ae5ab202e1a0a1e09ef885f68c16 /README.md
parentd1ff88e25cfdc52621a291034fa0dcbb390033c8 (diff)
Convert positional arguments to required long flags
Replace positional arguments with explicit long flags for better usability: - job_id → --job-id - addresses → --num-addresses - latency_matrix → --latency-matrix Update README.md with new command syntax examples. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 03aa9a7..671b4fb 100644
--- a/README.md
+++ b/README.md
@@ -21,19 +21,19 @@ The tool provides three main commands:
21### Setup Network (`up`) 21### Setup Network (`up`)
22Configure network interfaces and apply latency settings: 22Configure network interfaces and apply latency settings:
23```bash 23```bash
24uv run oar_p2p_net.py up <job_id> <addresses> <latency_matrix_file> 24uv run oar_p2p_net.py up --job-id <job_id> --num-addresses <addresses> --latency-matrix <latency_matrix_file>
25``` 25```
26 26
27### Cleanup Network (`down`) 27### Cleanup Network (`down`)
28Remove network configurations: 28Remove network configurations:
29```bash 29```bash
30uv run oar_p2p_net.py down <job_id> 30uv run oar_p2p_net.py down --job-id <job_id>
31``` 31```
32 32
33### Generate Configurations (`configurations`) 33### Generate Configurations (`configurations`)
34Preview the network configurations that would be applied: 34Preview the network configurations that would be applied:
35```bash 35```bash
36uv run oar_p2p_net.py configurations <job_id> <addresses> <latency_matrix_file> 36uv run oar_p2p_net.py configurations --job-id <job_id> --num-addresses <addresses> --latency-matrix <latency_matrix_file>
37``` 37```
38 38
39## Requirements 39## Requirements