globuzma/canaille-globuzma
1
0
Fork 0
forked from Github-Mirrors/canaille
Code Pull requests Activity

doc: add info how to run canaille CLI

Browse source
This commit is contained in:
Stéphane 2024-11-14 17:02:07 +01:00
parent 8f3ea59a70
commit a832c10c80
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/references/commands.rst
View file

@ -3,6 +3,13 @@ Command Line Interface
Canaille provide several commands to help administrator manage their data. 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: .. _cli_check:
.. click:: canaille.app.commands:check .. click:: canaille.app.commands:check