From 8b3a8dd153191d6aa818b1da5167abf520d97887 Mon Sep 17 00:00:00 2001
From: Luc Didry <luc@didry.org>
Date: Thu, 11 Apr 2024 09:12:01 +0200
Subject: [PATCH 1/3] =?UTF-8?q?=E2=9C=A8=20=E2=80=94=20Config=20file=20opt?=
 =?UTF-8?q?ion=20on=20almost=20all=20server=20commands?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 argos/commands.py | 37 +++++++++++++++++++++++++++++++++----
 docs/cli.md       |  5 ++++-
 2 files changed, 37 insertions(+), 5 deletions(-)

diff --git a/argos/commands.py b/argos/commands.py
index ca87647..691edde 100644
--- a/argos/commands.py
+++ b/argos/commands.py
@@ -87,7 +87,12 @@ def agent(server_url, auth, max_tasks, wait_time, log_level):
 @server.command()
 @click.option("--host", default="127.0.0.1", help="Host to bind")
 @click.option("--port", default=8000, type=int, help="Port to bind")
-@click.option("--config", default="config.yaml", help="Path the the configuration file")
+@click.option(
+    "--config",
+    default="config.yaml",
+    help="Path the the configuration file",
+    envvar="ARGOS_YAML_FILE",
+)
 @click.option("--reload", is_flag=True, help="Enable hot reloading")
 def start(host, port, config, reload):
     """Starts the server"""
@@ -124,8 +129,14 @@ def validate_max_results(ctx, param, value):
     ),
     callback=validate_max_lock_seconds,
 )
+@click.option(
+    "--config",
+    default="config.yaml",
+    help="Path the the configuration file",
+    envvar="ARGOS_YAML_FILE",
+)
 @coroutine
-async def cleandb(max_results, max_lock_seconds):
+async def cleandb(max_results, max_lock_seconds, config):
     """Clean the database (to run routinely)
 
     \b
@@ -135,6 +146,8 @@ async def cleandb(max_results, max_lock_seconds):
     # The imports are made here otherwise the agent will need server configuration files.
     from argos.server import queries
 
+    os.environ["ARGOS_YAML_FILE"] = config
+
     db = await get_db()
     removed = await queries.remove_old_results(db, max_results)
     updated = await queries.release_old_locks(db, max_lock_seconds)
@@ -144,14 +157,22 @@ async def cleandb(max_results, max_lock_seconds):
 
 
 @server.command()
+@click.option(
+    "--config",
+    default="config.yaml",
+    help="Path the the configuration file",
+    envvar="ARGOS_YAML_FILE",
+)
 @coroutine
-async def reload_config():
+async def reload_config(config):
     """Read tasks configuration and add/delete tasks in database if needed"""
     # The imports are made here otherwise the agent will need server configuration files.
     from argos.server import queries
     from argos.server.main import get_application, read_config
     from argos.server.settings import get_app_settings
 
+    os.environ["ARGOS_YAML_FILE"] = config
+
     appli = get_application()
     settings = get_app_settings()
     config = read_config(appli, settings)
@@ -164,12 +185,20 @@ async def reload_config():
 
 
 @server.command()
+@click.option(
+    "--config",
+    default="config.yaml",
+    help="Path the the configuration file",
+    envvar="ARGOS_YAML_FILE",
+)
 @coroutine
-async def migrate():
+async def migrate(config):
     """Run database migrations"""
     # The imports are made here otherwise the agent will need server configuration files.
     from argos.server.settings import get_app_settings
 
+    os.environ["ARGOS_YAML_FILE"] = config
+
     settings = get_app_settings()
 
     alembic_cfg = Config("alembic.ini")
diff --git a/docs/cli.md b/docs/cli.md
index 472f8d6..92f3dc2 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -122,6 +122,7 @@ Usage: argos server migrate [OPTIONS]
   Run database migrations
 
 Options:
+  --config TEXT  Path the the configuration file
   --help  Show this message and exit.
 ```
 
@@ -129,7 +130,7 @@ Options:
 -->
 
 
-### Server clean
+### Server cleandb
 <!--
 .. [[[cog
     help(["server", "cleandb", "--help"])
@@ -148,6 +149,7 @@ Options:
   --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)
+  --config TEXT  Path the the configuration file
   --help                      Show this message and exit.
 ```
 
@@ -167,6 +169,7 @@ Usage: argos server reload-config [OPTIONS]
   Read tasks configuration and add/delete tasks in database if needed
 
 Options:
+  --config TEXT  Path the the configuration file
   --help  Show this message and exit.
 ```
 

From cf4441be297601f051764aa79d9ebdbedc46c0f9 Mon Sep 17 00:00:00 2001
From: Luc Didry <luc@didry.org>
Date: Thu, 11 Apr 2024 09:26:01 +0200
Subject: [PATCH 2/3] =?UTF-8?q?=F0=9F=93=9D=20=E2=80=94=20Improve=20help?=
 =?UTF-8?q?=20messages?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 argos/commands.py | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

diff --git a/argos/commands.py b/argos/commands.py
index 691edde..e9e3e51 100644
--- a/argos/commands.py
+++ b/argos/commands.py
@@ -90,7 +90,8 @@ def agent(server_url, auth, max_tasks, wait_time, log_level):
 @click.option(
     "--config",
     default="config.yaml",
-    help="Path the the configuration file",
+    help="Path of the configuration file. "
+    "If ARGOS_YAML_FILE environment variable is set, its value will be used instead.",
     envvar="ARGOS_YAML_FILE",
 )
 @click.option("--reload", is_flag=True, help="Enable hot reloading")
@@ -132,7 +133,8 @@ def validate_max_results(ctx, param, value):
 @click.option(
     "--config",
     default="config.yaml",
-    help="Path the the configuration file",
+    help="Path of the configuration file. "
+    "If ARGOS_YAML_FILE environment variable is set, its value will be used instead.",
     envvar="ARGOS_YAML_FILE",
 )
 @coroutine
@@ -156,16 +158,17 @@ async def cleandb(max_results, max_lock_seconds, config):
     click.echo(f"{updated} locks released")
 
 
-@server.command()
+@server.command(short_help="Load or reload tasks’ configuration")
 @click.option(
     "--config",
     default="config.yaml",
-    help="Path the the configuration file",
+    help="Path of the configuration file. "
+    "If ARGOS_YAML_FILE environment variable is set, its value will be used instead.",
     envvar="ARGOS_YAML_FILE",
 )
 @coroutine
 async def reload_config(config):
-    """Read tasks configuration and add/delete tasks in database if needed"""
+    """Read tasks’ configuration and add/delete tasks in database if needed"""
     # The imports are made here otherwise the agent will need server configuration files.
     from argos.server import queries
     from argos.server.main import get_application, read_config
@@ -188,7 +191,8 @@ async def reload_config(config):
 @click.option(
     "--config",
     default="config.yaml",
-    help="Path the the configuration file",
+    help="Path of the configuration file. "
+    "If ARGOS_YAML_FILE environment variable is set, its value will be used instead.",
     envvar="ARGOS_YAML_FILE",
 )
 @coroutine
@@ -206,7 +210,7 @@ async def migrate(config):
     command.upgrade(alembic_cfg, "head")
 
 
-@server.command()
+@server.command(short_help="Generate a token for agents")
 @coroutine
 async def generate_token():
     """Generate a token, which can be used as an agent’s authentication token.

From f125557f814689384a6710fa39aeab18edb5a930 Mon Sep 17 00:00:00 2001
From: Luc Didry <luc@didry.org>
Date: Thu, 11 Apr 2024 14:53:31 +0200
Subject: [PATCH 3/3] =?UTF-8?q?=E2=9C=8F=20=E2=80=94=20Fix=20typos?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/cli.md | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/docs/cli.md b/docs/cli.md
index 92f3dc2..64206b3 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -101,7 +101,7 @@ Usage: argos server start [OPTIONS]
 Options:
   --host TEXT     Host to bind
   --port INTEGER  Port to bind
-  --config TEXT   Path the the configuration file
+  --config TEXT   Path of the configuration file
   --reload        Enable hot reloading
   --help          Show this message and exit.
 ```
@@ -122,8 +122,8 @@ Usage: argos server migrate [OPTIONS]
   Run database migrations
 
 Options:
-  --config TEXT  Path the the configuration file
-  --help  Show this message and exit.
+  --config TEXT  Path of the configuration file
+  --help         Show this message and exit.
 ```
 
 <!--[[[end]]]
@@ -149,7 +149,7 @@ Options:
   --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)
-  --config TEXT  Path the the configuration file
+  --config TEXT               Path of the configuration file
   --help                      Show this message and exit.
 ```
 
@@ -169,8 +169,8 @@ Usage: argos server reload-config [OPTIONS]
   Read tasks configuration and add/delete tasks in database if needed
 
 Options:
-  --config TEXT  Path the the configuration file
-  --help  Show this message and exit.
+  --config TEXT  Path of the configuration file
+  --help         Show this message and exit.
 ```
 
 <!--[[[end]]]