Skip to content

Commit 6493b0a

Browse files
Paolo Calaopolldo
Paolo Calao
authored andcommitted
Improve config readme (#75)
Update readme
1 parent 4a36d00 commit 6493b0a

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

Diff for: README.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,18 @@ Another example: let's say that the execution of the previous command results in
3131

3232
## Set a configuration
3333

34-
arduino-cloud-cli needs a configuration file to be used. At the moment, the configuration file should be contained in the same directory where the cli commands are executed.
35-
The configuration file contains the Arduino IoT Cloud client ID and its corresponding secret.
36-
You can retrieve them from the [cloud](https://create.arduino.cc/iot/integrations) by creating a new API key.
34+
arduino-cloud-cli needs a configuration file containing an Arduino IoT Cloud client ID and its corresponding secret.
35+
You can retrieve these credentials from the [cloud](https://create.arduino.cc/iot/integrations) by creating a new API key.
3736

38-
Once you have the IDs, call this command to init a new configuration file:
37+
Once you have the credentials, execute the following command and provide them when asked to create a new configuration file:
3938

4039
`$ arduino-cloud-cli config init`
4140

42-
A file named `arduino-cloud.yaml` will be created in the current working directory.
43-
Then you should open such file and replace the client and secret placeholders with the value you previously retrieved.
41+
By default it will be created in the arduino data directory (arduino15).
42+
You can specify a different destination folder with the `--dest-dir` option.
43+
arduino-cloud-cli looks for its configuration file in different directories in the following order: current working directory, parents of the current working directory, arduino15 default directory.
4444

45-
46-
To create a configuration file in a different folder, use this command:
45+
This gives you the possibility to use different configuration files depending on the project you are working on.
4746

4847
`$ arduino-cloud-cli config init --dest-dir <destinationFolder>`
4948

0 commit comments

Comments
 (0)