From 2af566beefd782530294c368da4fc156effa436a Mon Sep 17 00:00:00 2001 From: vschaffn Date: Wed, 30 Oct 2024 14:08:35 +0100 Subject: [PATCH] docs: add cli doc --- doc/source/quick_start.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/source/quick_start.md b/doc/source/quick_start.md index da3058bb..e48bc5b4 100644 --- a/doc/source/quick_start.md +++ b/doc/source/quick_start.md @@ -112,6 +112,21 @@ import os os.remove("dh_error.tif") ``` +## Command Line Interface (CLI) + +The xDEM package can be executed from the command line using the `xdem` command. + +### Usage + +```bash +xdem path_ref path_sec [options] +``` + +### Options + +- `--loglevel`: Set the logging level (default: INFO). +- `-v`, `--version`: Show the version of the xDEM package. + (quick-gallery)= ## More examples