Covalent CLI Tool#
This Command Line Interface (CLI) tool is used to manage Covalent server.
covalent#
Covalent CLI tool used to manage the servers.
covalent [OPTIONS] COMMAND [ARGS]...
Options
- -v, --version#
Display version information.
start#
Start the Covalent server.
covalent start [OPTIONS]
Options
- -d, --develop#
Start the server in developer mode.
- -p, --port <port>#
Server port number.
- Default
48008
- -m, --mem-per-worker <mem_per_worker>#
Memory limit per worker in (GB). Provide strings like 1gb/1GB or 0 for no limits
- -n, --workers <workers>#
Number of workers to start covalent with.
- -t, --threads-per-worker <threads_per_worker>#
Number of CPU threads per worker.
- --ignore-migrations#
Start the server without requiring migrations
- Default
False
- --no-cluster#
Start the server without Dask
- Default
False
- --no-triggers#
Start Covalent server without the Triggers server
- Default
False
- --triggers-only#
Start only the Triggers server
- Default
False
stop#
Stop the Covalent server.
covalent stop [OPTIONS]
restart#
Restart the server.
covalent restart [OPTIONS]
Options
- -p, --port <port>#
Restart Covalent server on a different port.
- -d, --develop#
Start the server in developer mode.
status#
Query the status of the Covalent server.
covalent status [OPTIONS]
purge#
Purge Covalent from this system. This command is for developers.
covalent purge [OPTIONS]
Options
- -H, --hard#
Perform a hard purge, deleting the DB as well. [default: False]
- -y, --yes#
Approve without showing the warning. [default: False]
logs#
Show Covalent server logs.
covalent logs [OPTIONS]
db#
Group of utility commands to manage dispatcher database
covalent db [OPTIONS] COMMAND [ARGS]...
alembic#
Expose alembic CLI to be used via covalent CLI
covalent db alembic [OPTIONS] [ALEMBIC_ARGS]...
Arguments
- ALEMBIC_ARGS#
Optional argument(s)
migrate#
Run DB Migrations programatically
covalent db migrate [OPTIONS]
cluster#
Inspect and manage the Dask cluster’s configuration.
covalent cluster [OPTIONS]
Options
- --status#
Show Dask cluster status
- --info#
Retrieve Dask cluster info
- --address#
Fetch connection information of the cluster scheduler/workers
- --size#
Return number of active workers in the cluster
- --restart#
Restart the cluster
- --scale <scale>#
Scale cluster by adding/removing workers to match nworkers
- Default
2
- --logs#
Show Dask cluster logs