You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -12,18 +12,18 @@ This is all you need to use arduino-cloud-cli:
12
12
13
13
### Additional info
14
14
15
-
This tool follows a "quiet on success/verbose on error" behaviour. This means that when the execution of a command results in an error, such error is printed. On the other hand, when the command is successfully executed, there is no 'success' feedback on the output: the results of the command, if any, are directly printed without any other feedback informations. This strategy allows users to save the output of the command in a file.
15
+
This tool follows a "quiet on success/verbose on error" behaviour. This means that when a command execution result is an error, such error is printed. On the other hand, when the command is successfully executed, there is no 'success' feedback on the output: the results of the command, if any, are directly printed without any other feedback. This strategy allows users to save the output of the command in a file.
16
16
17
-
However, if the verbose flag `-v` is used, then the behaviour will change: the logs will always be printed out providing users with feedbacks on the execution of the command.
17
+
However, if the verbose flag `-v` is used, then the behaviour will change: the logs will always be printed out, providing users with feedback on the execution of the command.
18
18
19
-
As an example, let's take the `device create`command. We want to save the information of the newly created device in a file.
19
+
As an example, let's take the `device create`command. We want to save the information of the newly created device in a file.
The resulting mydevice.json will only contain device information in a json format.
25
25
26
-
Another example: let's say that the execution of the previous command results in an error. In that case the json file will be empty and the terminal will print out the error. Now we want to execute again the command with the logs enabled, in order to understand the issue. So we execute the following:
26
+
Another example: let's say that the execution of the previous command results in an error. In that case, the json file will be empty and the terminal will print out the error. Now we want to execute the command again with the logs enabled in order to understand the issue. So we execute the following:
@@ -37,7 +37,7 @@ Once you have the credentials, execute the following command and provide them:
37
37
38
38
`$ arduino-cloud-cli credentials init`
39
39
40
-
By default it will be created in the arduino data directory (arduino15).
40
+
By default it will be created in the Arduino data directory (Arduino15).
41
41
You can specify a different destination folder with the `--dest-dir` option.
42
42
arduino-cloud-cli looks for its credentials file in different directories in the following order: current working directory, parents of the current working directory, arduino15 default directory.
43
43
@@ -49,7 +49,7 @@ To reset an old credentials file, just overwrite it using this command:
@@ -63,7 +63,7 @@ To have information about which credentials would be used in the current folder
63
63
64
64
## Device provisioning
65
65
66
-
When provisioning a device, you can optionally specify the port to which the device is connected to and its fqbn. If they are not given, then the first device found will be provisioned.
66
+
When provisioning a device, you can optionally specify the port to which the device is connected and its fqbn. If they are not given, then the first device found will be provisioned.
67
67
68
68
Use this command to provision a device:
69
69
@@ -121,11 +121,11 @@ Delete specific tags of a device. The keys of the tags to delete should be passe
121
121
122
122
Things can be created starting from a template or by cloning another thing.
123
123
124
-
Create a thing from a thing template. Supported template formats are JSON and YAML. The name parameter is optional. If it is provided then it overrides the name retrieved from the template:
124
+
Create a thing from a thing template. Supported template formats are JSON and YAML. The name parameter is optional. If it is provided, then it overrides the name retrieved from the template:
Create a dashboard: dashboards can be created only starting from a template. Supported dashboard template formats are JSON and YAML. The name parameter is optional. If it is provided then it overrides the name retrieved from the template. The `override` flag can be used to override the template `thing_id` placeholder with the actual ID of the thing to be used.
211
+
Create a dashboard: dashboards can be created only starting from a template. Supported dashboard template formats are JSON and YAML. The name parameter is optional. If it is provided, then it overrides the name retrieved from the template. The `override` flag can be used to override the template `thing_id` placeholder with the actual ID of the thing to be used.
0 commit comments