Updated docs

pull/5221/head
SwiftyOS 2023-09-15 15:44:11 +02:00
parent 252d2fead1
commit 43fba808a2
2 changed files with 8 additions and 8 deletions

View File

@ -19,10 +19,10 @@ Options:
--help Show this message and exit. --help Show this message and exit.
Commands: Commands:
agents Agents group command agents Commands to create, start and stop agents
benchmark Benchmark group command benchmark Commands to start the benchmark and list tests and categories
frontend Frontend command group frontend Starts the frontend
setup Setup command setup Installs dependencies needed for your system.
``` ```
If you need assistance with any command, simply add the `--help` parameter to the end of your command, like so: If you need assistance with any command, simply add the `--help` parameter to the end of your command, like so:

8
cli.py
View File

@ -12,7 +12,7 @@ def cli():
@cli.command() @cli.command()
def setup(): def setup():
"""Setup command""" """Installs dependencies needed for your system. Works with Linux, MacOS and Windows WSL."""
import os import os
import subprocess import subprocess
script_dir = os.path.dirname(os.path.realpath(__file__)) script_dir = os.path.dirname(os.path.realpath(__file__))
@ -25,7 +25,7 @@ def setup():
@cli.group() @cli.group()
def agents(): def agents():
"""Agents group command""" """Commands to create, start and stop agents"""
pass pass
@agents.command() @agents.command()
@ -104,7 +104,7 @@ def list():
@cli.group() @cli.group()
def benchmark(): def benchmark():
"""Benchmark group command""" """Commands to start the benchmark and list tests and categories"""
pass pass
@benchmark.command(context_settings=dict( @benchmark.command(context_settings=dict(
@ -255,7 +255,7 @@ def benchmark_tests_details(test_name):
continue continue
@cli.command() @cli.command()
def frontend(): def frontend():
"""Frontend command group""" """Starts the frontend"""
import os import os
import subprocess import subprocess
import socket import socket