Skip to content

Commit 9238a6c

Browse files
authored
[skip changelog] Correct documentation re: arduino-cli config init behavior (#781)
- Configuration filename is now arduino-cli.yaml, not "cli-config.yml" - Default configuration file location is no longer correctly described as "$EXE_DIR". It is now directories.data. - Location of the written configuration file location may be customized via --dest-dir. - Current configuration is written, not the default configuration. - If configuration file already exists, it is updated with the current configuration.
1 parent a69a11a commit 9238a6c

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

cli/config/init.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ const defaultFileName = "arduino-cli.yaml"
3333
func initInitCommand() *cobra.Command {
3434
initCommand := &cobra.Command{
3535
Use: "init",
36-
Short: "Initializes a new configuration file into the default location.",
37-
Long: "Initializes a new configuration file into the default location ($EXE_DIR/cli-config.yml).",
36+
Short: "Writes current configuration to a configuration file.",
37+
Long: "Creates or updates the configuration file in the data directory or custom directory with the current configuration settings.",
3838
Example: "" +
39-
" # Creates a default configuration file into the default location.\n" +
39+
" # Writes current configuration to the configuration file in the data directory.\n" +
4040
" " + os.Args[0] + " config init",
4141
Args: cobra.NoArgs,
4242
Run: runInitCommand,

0 commit comments

Comments
 (0)