Skip to content
This repository was archived by the owner on Nov 14, 2022. It is now read-only.

Commit 953b7cf

Browse files
makr11stmakr11st
authored
Create tedge cli reference docs
1 parent 5b91872 commit 953b7cf

File tree

6 files changed

+98
-134
lines changed

6 files changed

+98
-134
lines changed

‎docs/src/references/tedge-cert.md

+18-29
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
# The `tedge cert` command
22

33
```
4-
tedge-cert 0.5.3
4+
tedge-cert
55
Create and manage device certificate
66
77
USAGE:
88
tedge cert <SUBCOMMAND>
99
10-
FLAGS:
11-
-h, --help Prints help information
12-
-V, --version Prints version information
10+
OPTIONS:
11+
-h, --help Print help information
1312
1413
SUBCOMMANDS:
1514
create Create a self-signed device certificate
16-
help Prints this message or the help of the given subcommand(s)
15+
help Print this message or the help of the given subcommand(s)
1716
remove Remove the device certificate
1817
show Show the device certificate, if any
1918
upload Upload root certificate
@@ -22,66 +21,56 @@ SUBCOMMANDS:
2221
## Create
2322

2423
```
25-
tedge-cert-create 0.5.3
24+
tedge-cert-create
2625
Create a self-signed device certificate
2726
2827
USAGE:
29-
tedge cert create --device-id <id>
30-
31-
FLAGS:
32-
-h, --help Prints help information
33-
-V, --version Prints version information
28+
tedge cert create --device-id <ID>
3429
3530
OPTIONS:
36-
--device-id <id> The device identifier to be used as the common name for the certificate
31+
--device-id <ID> The device identifier to be used as the common name for the certificate
32+
-h, --help Print help information
3733
```
3834

3935
## Show
4036

4137
```
42-
tedge-cert-show 0.5.3
38+
tedge-cert-show
4339
Show the device certificate, if any
4440
4541
USAGE:
4642
tedge cert show
4743
48-
FLAGS:
49-
-h, --help Prints help information
50-
-V, --version Prints version information
44+
OPTIONS:
45+
-h, --help Print help information
5146
```
5247

5348
## Remove
5449

5550
```
56-
tedge-cert-remove 0.5.3
51+
tedge-cert-remove
5752
Remove the device certificate
5853
5954
USAGE:
6055
tedge cert remove
6156
62-
FLAGS:
63-
-h, --help Prints help information
64-
-V, --version Prints version information
57+
OPTIONS:
58+
-h, --help Print help information
6559
```
6660

6761
## Upload
6862

6963
```
70-
tedge-cert-upload 0.5.3
64+
tedge-cert-upload
7165
Upload root certificate
7266
7367
USAGE:
7468
tedge cert upload <SUBCOMMAND>
7569
76-
FLAGS:
77-
-h, --help
78-
Prints help information
79-
80-
-V, --version
81-
Prints version information
82-
70+
OPTIONS:
71+
-h, --help Print help information
8372
8473
SUBCOMMANDS:
8574
c8y Upload root certificate to Cumulocity
86-
help Prints this message or the help of the given subcommand(s)
75+
help Print this message or the help of the given subcommand(s)
8776
```

‎docs/src/references/tedge-config.md

+29-34
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
# The `tedge config` command
22

33
```
4-
tedge-config 0.5.3
4+
tedge-config
55
Configure Thin Edge
66
77
USAGE:
88
tedge config <SUBCOMMAND>
99
10-
FLAGS:
11-
-h, --help Prints help information
12-
-V, --version Prints version information
10+
OPTIONS:
11+
-h, --help Print help information
1312
1413
SUBCOMMANDS:
1514
get Get the value of the provided configuration key
16-
help Prints this message or the help of the given subcommand(s)
15+
help Print this message or the help of the given subcommand(s)
1716
list Print the configuration keys and their values
1817
set Set or update the provided configuration key with the given value
1918
unset Unset the provided configuration key
@@ -22,67 +21,63 @@ SUBCOMMANDS:
2221
## Get
2322

2423
```
25-
tedge-config-get 0.5.3
24+
tedge-config-get
2625
Get the value of the provided configuration key
2726
2827
USAGE:
29-
tedge config get <key>
30-
31-
FLAGS:
32-
-h, --help Prints help information
33-
-V, --version Prints version information
28+
tedge config get <KEY>
3429
3530
ARGS:
36-
<key> Configuration key. Run `tedge config list --doc` for available keys
31+
<KEY> Configuration key. Run `tedge config list --doc` for available keys
32+
33+
OPTIONS:
34+
-h, --help Print help information
3735
```
3836

3937
## Set
4038

4139
```
42-
tedge-config-set 0.5.3
40+
tedge-config-set
4341
Set or update the provided configuration key with the given value
4442
4543
USAGE:
46-
tedge config set <key> <value>
47-
48-
FLAGS:
49-
-h, --help Prints help information
50-
-V, --version Prints version information
44+
tedge config set <KEY> <VALUE>
5145
5246
ARGS:
53-
<key> Configuration key. Run `tedge config list --doc` for available keys
54-
<value> Configuration value
47+
<KEY> Configuration key. Run `tedge config list --doc` for available keys
48+
<VALUE> Configuration value
49+
50+
OPTIONS:
51+
-h, --help Print help information
5552
```
5653

5754
## List
5855

5956
```
60-
tedge-config-list 0.5.3
57+
tedge-config-list
6158
Print the configuration keys and their values
6259
6360
USAGE:
64-
tedge config list [FLAGS]
61+
tedge config list [OPTIONS]
6562
66-
FLAGS:
67-
-h, --help Prints help information
68-
--all Prints all the configuration keys, even those without a configured value
69-
--doc Prints all keys and descriptions with example values
70-
-V, --version Prints version information
63+
OPTIONS:
64+
--all Prints all the configuration keys, even those without a configured value
65+
--doc Prints all keys and descriptions with example values
66+
-h, --help Print help information
7167
```
7268

7369
## Unset
7470

7571
```
76-
tedge-config-unset 0.5.3
72+
tedge-config-unset
7773
Unset the provided configuration key
7874
7975
USAGE:
80-
tedge config unset <key>
81-
82-
FLAGS:
83-
-h, --help Prints help information
84-
-V, --version Prints version information
76+
tedge config unset <KEY>
8577
8678
ARGS:
87-
<key> Configuration key. Run `tedge config list --doc` for available keys
79+
<KEY> Configuration key. Run `tedge config list --doc` for available keys
80+
81+
OPTIONS:
82+
-h, --help Print help information
8883
```

‎docs/src/references/tedge-connect.md

+16-27
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,55 @@
11
# The `tedge connect` command
22

33
```
4-
tedge-connect 0.5.3
4+
tedge-connect
55
Connect to connector provider
66
77
USAGE:
88
tedge connect <SUBCOMMAND>
99
10-
FLAGS:
11-
-h, --help
12-
Prints help information
13-
14-
-V, --version
15-
Prints version information
16-
10+
OPTIONS:
11+
-h, --help Print help information
1712
1813
SUBCOMMANDS:
1914
az Create connection to Azure
2015
c8y Create connection to Cumulocity
21-
help Prints this message or the help of the given subcommand(s)
16+
help Print this message or the help of the given subcommand(s)
2217
```
2318

2419
## Azure
2520

2621
```
27-
tedge-connect-az 0.5.3
22+
tedge-connect-az
2823
Create connection to Azure
2924
3025
The command will create config and start edge relay from the device to az instance
3126
3227
USAGE:
33-
tedge connect az [FLAGS]
28+
tedge connect az [OPTIONS]
3429
35-
FLAGS:
36-
-h, --help
37-
Prints help information
30+
OPTIONS:
31+
-h, --help
32+
Print help information
3833
39-
--test
34+
--test
4035
Test connection to Azure
41-
42-
-V, --version
43-
Prints version information
4436
```
4537

4638
## Cumulocity
4739

4840
```
49-
tedge-connect-c8y 0.5.3
41+
tedge-connect-c8y
5042
Create connection to Cumulocity
5143
5244
The command will create config and start edge relay from the device to c8y instance
5345
5446
USAGE:
55-
tedge connect c8y [FLAGS]
47+
tedge connect c8y [OPTIONS]
5648
57-
FLAGS:
58-
-h, --help
59-
Prints help information
49+
OPTIONS:
50+
-h, --help
51+
Print help information
6052
61-
--test
53+
--test
6254
Test connection to Cumulocity
63-
64-
-V, --version
65-
Prints version information
6655
```

‎docs/src/references/tedge-disconnect.md

+10-13
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,43 @@
11
# The `tedge disconnect` command
22

33
```
4-
tedge-disconnect 0.5.3
4+
tedge-disconnect
55
Remove bridge connection for a provider
66
77
USAGE:
88
tedge disconnect <SUBCOMMAND>
99
10-
FLAGS:
11-
-h, --help Prints help information
12-
-V, --version Prints version information
10+
OPTIONS:
11+
-h, --help Print help information
1312
1413
SUBCOMMANDS:
1514
az Remove bridge connection to Azure
1615
c8y Remove bridge connection to Cumulocity
17-
help Prints this message or the help of the given subcommand(s)
16+
help Print this message or the help of the given subcommand(s)
1817
```
1918

2019
## Azure
2120

2221
```
23-
tedge-disconnect-az 0.5.3
22+
tedge-disconnect-az
2423
Remove bridge connection to Azure
2524
2625
USAGE:
2726
tedge disconnect az
2827
29-
FLAGS:
30-
-h, --help Prints help information
31-
-V, --version Prints version information
28+
OPTIONS:
29+
-h, --help Print help information
3230
```
3331

3432
## Cumulocity
3533

3634
```
37-
tedge-disconnect-c8y 0.5.3
35+
tedge-disconnect-c8y
3836
Remove bridge connection to Cumulocity
3937
4038
USAGE:
4139
tedge disconnect c8y
4240
43-
FLAGS:
44-
-h, --help Prints help information
45-
-V, --version Prints version information
41+
OPTIONS:
42+
-h, --help Print help information
4643
```

0 commit comments

Comments
 (0)