mirror of
https://framagit.org/framasoft/framaspace/argos.git
synced 2025-04-28 18:02:41 +02:00
174 lines
3.4 KiB
Markdown
174 lines
3.4 KiB
Markdown
# Command-line interface
|
|
|
|
<!-- [[[cog
|
|
from argos.commands import cli
|
|
from click.testing import CliRunner
|
|
def help(args):
|
|
title = "argos " + " ".join(args)
|
|
cog.out("\n```man\n")
|
|
result = CliRunner().invoke(cli, args)
|
|
output = result.output.replace("Usage: cli ", "Usage: argos ")
|
|
cog.out(output)
|
|
cog.out("```\n\n")
|
|
]]] -->
|
|
<!-- [[[end]]] -->
|
|
|
|
## The argos cli
|
|
<!--
|
|
.. [[[cog
|
|
help(["--help"])
|
|
.. ]]] -->
|
|
|
|
```man
|
|
Usage: argos [OPTIONS] COMMAND [ARGS]...
|
|
|
|
Options:
|
|
--help Show this message and exit.
|
|
|
|
Commands:
|
|
agent Get and run tasks to the provided server.
|
|
server
|
|
```
|
|
|
|
<!--[[[end]]]
|
|
-->
|
|
|
|
## Agent commands
|
|
<!--
|
|
.. [[[cog
|
|
help(["agent", "--help"])
|
|
.. ]]] -->
|
|
|
|
```man
|
|
Usage: argos agent [OPTIONS] SERVER_URL AUTH
|
|
|
|
Get and run tasks to the provided server. Will wait for new tasks.
|
|
|
|
Usage: argos agent https://argos.example.org "auth-token-here"
|
|
|
|
Alternatively, you can use the following environment variables to avoid
|
|
passing arguments to the agent on the command line:
|
|
|
|
ARGOS_AGENT_SERVER_URL=https://argos.example.org
|
|
ARGOS_AGENT_TOKEN=auth-token-here
|
|
|
|
Options:
|
|
--max-tasks INTEGER Number of concurrent tasks this agent can
|
|
run
|
|
--wait-time INTEGER Waiting time between two polls on the server
|
|
(seconds)
|
|
--log-level [DEBUG|INFO|WARNING|ERROR|CRITICAL]
|
|
--help Show this message and exit.
|
|
```
|
|
|
|
<!--[[[end]]]
|
|
-->
|
|
|
|
## Server commands
|
|
<!--
|
|
.. [[[cog
|
|
help(["server", "--help"])
|
|
.. ]]] -->
|
|
|
|
```man
|
|
Usage: argos server [OPTIONS] COMMAND [ARGS]...
|
|
|
|
Options:
|
|
--help Show this message and exit.
|
|
|
|
Commands:
|
|
cleandb Clean the database (to run routinely)
|
|
migrate Run database migrations
|
|
reload-config Read tasks config and add/delete tasks in database if...
|
|
start Starts the server
|
|
```
|
|
|
|
<!--[[[end]]]
|
|
-->
|
|
|
|
### Server start
|
|
<!--
|
|
.. [[[cog
|
|
help(["server", "start", "--help"])
|
|
.. ]]] -->
|
|
|
|
```man
|
|
Usage: argos server start [OPTIONS]
|
|
|
|
Starts the server
|
|
|
|
Options:
|
|
--host TEXT Host to bind
|
|
--port INTEGER Port to bind
|
|
--config TEXT Path the the configuration file
|
|
--reload Enable hot reloading
|
|
--help Show this message and exit.
|
|
```
|
|
|
|
<!--[[[end]]]
|
|
-->
|
|
|
|
### Server migrate
|
|
|
|
<!--
|
|
.. [[[ cog
|
|
help(["server", "migrate", "--help"])
|
|
.. ]]] -->
|
|
|
|
```man
|
|
Usage: argos server migrate [OPTIONS]
|
|
|
|
Run database migrations
|
|
|
|
Options:
|
|
--help Show this message and exit.
|
|
```
|
|
|
|
<!--[[[end]]]
|
|
-->
|
|
|
|
|
|
### Server clean
|
|
<!--
|
|
.. [[[cog
|
|
help(["server", "cleandb", "--help"])
|
|
.. ]]] -->
|
|
|
|
```man
|
|
Usage: argos server cleandb [OPTIONS]
|
|
|
|
Clean the database (to run routinely)
|
|
|
|
- Removes old results from the database.
|
|
- Removes locks from tasks that have been locked for too long.
|
|
|
|
Options:
|
|
--max-results INTEGER Number of results per task to keep
|
|
--max-lock-seconds INTEGER The number of seconds after which a lock is
|
|
considered stale, must be higher than 60 (the
|
|
checks have a timeout value of 60 seconds)
|
|
--help Show this message and exit.
|
|
```
|
|
|
|
<!--[[[end]]]
|
|
-->
|
|
|
|
### Server reload-config
|
|
|
|
<!--
|
|
.. [[[ cog
|
|
help(["server", "reload-config", "--help"])
|
|
.. ]]] -->
|
|
|
|
```man
|
|
Usage: argos server reload-config [OPTIONS]
|
|
|
|
Read tasks configuration and add/delete tasks in database if needed
|
|
|
|
Options:
|
|
--help Show this message and exit.
|
|
```
|
|
|
|
<!--[[[end]]]
|
|
-->
|
|
|