Skip to content

Commit

Permalink
Update docs for tedge cli
Browse files Browse the repository at this point in the history
Signed-off-by: Didier Wenzek <[email protected]>
  • Loading branch information
didier-wenzek committed Jan 6, 2025
1 parent b735319 commit 6a61c48
Showing 1 changed file with 30 additions and 10 deletions.
40 changes: 30 additions & 10 deletions docs/src/references/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,11 @@ sidebar_position: 4
# The tedge command

```sh title="tedge"
tedge is the cli tool for thin-edge.io
Command line interface to interact with thin-edge.io

USAGE:
tedge [OPTIONS] [SUBCOMMAND]
Usage: tedge [OPTIONS] <COMMAND>

OPTIONS:
--config-dir <CONFIG_DIR> [env: TEDGE_CONFIG_DIR, default: /etc/tedge]
-h, --help Print help information
--init Initialize the tedge
-V, --version Print version information

SUBCOMMANDS:
Commands:
init Initialize Thin Edge
cert Create and manage device certificate
config Configure Thin Edge
Expand All @@ -28,5 +21,32 @@ SUBCOMMANDS:
refresh-bridges Refresh all currently active mosquitto bridges
upload Upload files to the cloud
mqtt Publish a message on a topic and subscribe a topic
mapper Launch a cloud mapper
agent Run the agent
write Write standard input to a target file
help Print this message or the help of the given subcommand(s)

Options:
--config-dir <CONFIG_DIR>
[env: TEDGE_CONFIG_DIR, default: /etc/tedge]

--debug
Turn-on the DEBUG log level.

If off only reports ERROR, WARN, and INFO, if on also reports DEBUG

--log-level <LOG_LEVEL>
Configures the logging level.

One of error/warn/info/debug/trace.
Logs with verbosity lower or equal to the selected level will be printed,
i.e. warn prints ERROR and WARN logs and trace prints logs of all levels.

Overrides `--debug`

-h, --help
Print help (see a summary with '-h')

-V, --version
Print version
```

0 comments on commit 6a61c48

Please sign in to comment.