From a832c10c80bbf0890fa7ed5718467476880db405 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane?= Date: Thu, 14 Nov 2024 17:02:07 +0100 Subject: [PATCH] doc: add info how to run canaille CLI --- doc/references/commands.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/references/commands.rst b/doc/references/commands.rst index 9b613952..84898cab 100644 --- a/doc/references/commands.rst +++ b/doc/references/commands.rst @@ -3,6 +3,13 @@ Command Line Interface Canaille provide several commands to help administrator manage their data. +The configuration file has to be prefixed before running `canaille`. For readability's sake, it's omitted in the examples. + +.. code-block:: shell + + env CONFIG=path/to/config.toml canaille ... + + .. _cli_check: .. click:: canaille.app.commands:check