diff options
| author | diogo464 <[email protected]> | 2025-06-30 10:34:16 +0100 |
|---|---|---|
| committer | diogo464 <[email protected]> | 2025-06-30 10:34:16 +0100 |
| commit | c1d2c4d643bb874b3f974d814750d424db616ccd (patch) | |
| tree | ffd258c45809ae5ab202e1a0a1e09ef885f68c16 /README.md | |
| parent | d1ff88e25cfdc52621a291034fa0dcbb390033c8 (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.md | 6 |
1 files changed, 3 insertions, 3 deletions
| @@ -21,19 +21,19 @@ The tool provides three main commands: | |||
| 21 | ### Setup Network (`up`) | 21 | ### Setup Network (`up`) |
| 22 | Configure network interfaces and apply latency settings: | 22 | Configure network interfaces and apply latency settings: |
| 23 | ```bash | 23 | ```bash |
| 24 | uv run oar_p2p_net.py up <job_id> <addresses> <latency_matrix_file> | 24 | uv 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`) |
| 28 | Remove network configurations: | 28 | Remove network configurations: |
| 29 | ```bash | 29 | ```bash |
| 30 | uv run oar_p2p_net.py down <job_id> | 30 | uv run oar_p2p_net.py down --job-id <job_id> |
| 31 | ``` | 31 | ``` |
| 32 | 32 | ||
| 33 | ### Generate Configurations (`configurations`) | 33 | ### Generate Configurations (`configurations`) |
| 34 | Preview the network configurations that would be applied: | 34 | Preview the network configurations that would be applied: |
| 35 | ```bash | 35 | ```bash |
| 36 | uv run oar_p2p_net.py configurations <job_id> <addresses> <latency_matrix_file> | 36 | uv 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 |
