Skip to content

Commit

Permalink
docs: add cli doc
Browse files Browse the repository at this point in the history
  • Loading branch information
vschaffn committed Nov 18, 2024
1 parent 3f0693b commit 2af566b
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions doc/source/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 2af566b

Please sign in to comment.