Skip to content

Commit f236e6b

Browse files
authored
Update README.md (#6)
Added help
1 parent cf895f3 commit f236e6b

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,46 @@ Download the [latest release](https://github.com/microchip-pic-avr-tools/iotprov
1212

1313
## Getting Started and Documentation
1414

15-
The zip file contains command-line executables for Windows®, macOS®, and Linux® operating systems bundled with all the firmware needed to complete the provisioning. Extract and use the command-line utility corresponding to your operating system. You will find more instructions for running the tool in iotprovision.md found in the root folder.
15+
The zip file contains command-line executables for Windows®, macOS®, and Linux® operating systems bundled with all the firmware needed to complete the provisioning. Extract and use the command-line utility corresponding to your operating system. You will find more instructions for running the tool in iotprovision.md in the root folder.
16+
17+
### CLI usage
18+
Getting help:
19+
```
20+
iotprovision --help
21+
```
22+
Provision for Amazon Web Services, using Microchip sandbox account:
23+
```
24+
iotprovision -c aws -m sandbox
25+
```
26+
Provision for Amazon Web Services, using MAR and custom account:
27+
```
28+
iotprovision -c aws -m mar
29+
```
30+
Provision for Amazon Web Services, using JITR and custom account:
31+
```
32+
iotprovision -c aws -m jitr
33+
```
34+
Provision for Google Cloud Platform, using Microchip sandbox account:
35+
```
36+
iotprovision -c google -m sandbox
37+
```
38+
Provision for Microsoft Azure (preliminary - only kit provisioning):
39+
```
40+
iotprovision -c azure
41+
```
42+
The amount of logging is controlled by the -v/--verbose option:
43+
Possible log levels are `debug`, `info`, `warning`, `error`, `critical`. Default is `info`.
44+
```
45+
iotprovision -v debug
46+
```
47+
Print version info and exit:
48+
```
49+
iotprovision -V
50+
```
51+
Print release info and exit:
52+
```
53+
iotprovision -R
54+
```
1655

1756
### Other Helpful Resources
1857

0 commit comments

Comments
 (0)