Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 59c851e

Browse files
cmagliecmaglie
committedAug 12, 2018
Fixed some commands descriptions
1 parent 68d7520 commit 59c851e

File tree

20 files changed

+28
-26
lines changed

20 files changed

+28
-26
lines changed
 

‎commands/board/attach.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ func initAttachCommand() *cobra.Command {
4141
Short: "Attaches a sketch to a board.",
4242
Long: "Attaches a sketch to a board.",
4343
Example: "arduino board attach serial:///dev/tty/ACM0\n" +
44-
"arduino board attach serial:///dev/tty/ACM0 HelloWorld\n" +
45-
"arduino board attach arduino:samd:mkr1000",
44+
" " + commands.AppName + " board attach serial:///dev/tty/ACM0 HelloWorld\n" +
45+
" " + commands.AppName + " board attach arduino:samd:mkr1000",
4646
Args: cobra.RangeArgs(1, 2),
4747
Run: runAttachCommand,
4848
}

‎commands/board/list.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ func initListCommand() *cobra.Command {
3535
Use: "list",
3636
Short: "List connected boards.",
3737
Long: "Detects and displays a list of connected boards to the current computer.",
38-
Example: "arduino board list --timeout 10s",
38+
Example: " " + commands.AppName + " board list --timeout 10s",
3939
Args: cobra.NoArgs,
4040
Run: runListCommand,
4141
}

‎commands/board/listall.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ func initListAllCommand() *cobra.Command {
3131
Use: "listall",
3232
Short: "List all known boards.",
3333
Long: "List all boards that have the support platform installed.",
34-
Example: "arduino board listall",
34+
Example: " " + commands.AppName + " board listall",
3535
Args: cobra.NoArgs,
3636
Run: runListAllCommand,
3737
}

‎commands/config/dump.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ func initDumpCommand() *cobra.Command {
3232
Use: "dump",
3333
Short: "Prints the current configuration",
3434
Long: "Prints the current configuration.",
35-
Example: "arduino config dump",
35+
Example: " " + commands.AppName + " config dump",
3636
Args: cobra.NoArgs,
3737
Run: runDumpCommand,
3838
}

‎commands/config/init.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,10 @@ func initInitCommand() *cobra.Command {
3232
Short: "Initializes a new config file into the default location.",
3333
Long: "Initializes a new config file into the default location ($EXE_DIR/cli-config.yml).",
3434
Example: "" +
35-
"arduino config init # Creates a config file by asking questions to the user into the default location.\n" +
36-
"arduino config init --default # Creates a config file with default configuration into default location.",
35+
" # Creates a config file by asking questions to the user into the default location.\n" +
36+
" " + commands.AppName + " config init\n\n" +
37+
" # Creates a config file with default configuration into default location.\n" +
38+
" " + commands.AppName + " config init --default\n",
3739
Args: cobra.NoArgs,
3840
Run: runInitCommand,
3941
}

‎commands/core/download.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ func initDownloadCommand() *cobra.Command {
3434
Short: "Downloads one or more cores and corresponding tool dependencies.",
3535
Long: "Downloads one or more cores and corresponding tool dependencies.",
3636
Example: "" +
37-
"arduino core download arduino:samd # to download the latest version of arduino SAMD core.\n" +
38-
"arduino core download arduino:samd=1.6.9 # for a specific version (in this case 1.6.9).",
37+
" " + commands.AppName + "core download arduino:samd # to download the latest version of arduino SAMD core.\n" +
38+
" " + commands.AppName + "core download arduino:samd=1.6.9 # for a specific version (in this case 1.6.9).",
3939
Args: cobra.MinimumNArgs(1),
4040
Run: runDownloadCommand,
4141
}

‎commands/core/install.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import (
2929

3030
func initInstallCommand() *cobra.Command {
3131
installCommand := &cobra.Command{
32-
Use: "install [PACKAGER:ARCH[=VERSION]](S)",
32+
Use: "install PACKAGER:ARCH[@VERSION] ...",
3333
Short: "Installs one or more cores and corresponding tool dependencies.",
3434
Long: "Installs one or more cores and corresponding tool dependencies.",
3535
Example: "" +

‎commands/core/list.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ func initListCommand() *cobra.Command {
3131
Short: "Shows the list of installed cores.",
3232
Long: "Shows the list of installed cores.\n" +
3333
"With -v tag (up to 2 times) can provide more verbose output.",
34-
Example: "arduino core list -v # for a medium verbosity level.",
34+
Example: " " + commands.AppName + "core list -v # for a medium verbosity level.",
3535
Args: cobra.NoArgs,
3636
Run: runListCommand,
3737
}

‎commands/core/search.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ func initSearchCommand() *cobra.Command {
3232
Use: "search <keywords...>",
3333
Short: "Search for a core in the package index.",
3434
Long: "Search for a core in the package index using the specified keywords.",
35-
Example: "arduino core search MKRZero -v",
35+
Example: " " + commands.AppName + " core search MKRZero -v",
3636
Args: cobra.MinimumNArgs(1),
3737
Run: runSearchCommand,
3838
}

‎commands/core/update_index.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ func initUpdateIndexCommand() *cobra.Command {
3737
Use: "update-index",
3838
Short: "Updates the index of cores.",
3939
Long: "Updates the index of cores to the latest version.",
40-
Example: "arduino core update-index",
40+
Example: " " + commands.AppName + " core update-index",
4141
Args: cobra.NoArgs,
4242
Run: runUpdateIndexCommand,
4343
}

‎commands/lib/download.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ func initDownloadCommand() *cobra.Command {
3434
Short: "Downloads one or more libraries without installing them.",
3535
Long: "Downloads one or more libraries without installing them.",
3636
Example: "" +
37-
"arduino lib download AudioZero # for the latest version.\n" +
38-
"arduino lib download AudioZero@1.0.0 # for a specific version.",
37+
" " + commands.AppName + " lib download AudioZero # for the latest version.\n" +
38+
" " + commands.AppName + " lib download AudioZero@1.0.0 # for a specific version.",
3939
Args: cobra.MinimumNArgs(1),
4040
Run: runDownloadCommand,
4141
}

‎commands/lib/install.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ func initInstallCommand() *cobra.Command {
3434
Short: "Installs one of more specified libraries into the system.",
3535
Long: "Installs one or more specified libraries into the system.",
3636
Example: "" +
37-
"arduino lib install AudioZero # for the latest version.\n" +
38-
"arduino lib install AudioZero@1.0.0 # for the specific version.",
37+
" " + commands.AppName + " lib install AudioZero # for the latest version.\n" +
38+
" " + commands.AppName + " lib install AudioZero@1.0.0 # for the specific version.",
3939
Args: cobra.MinimumNArgs(1),
4040
Run: runInstallCommand,
4141
}

‎commands/lib/list.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ func initListCommand() *cobra.Command {
3535
Long: "Shows a list of all installed libraries.\n" +
3636
"Can be used with -v (or --verbose) flag (up to 2 times) to have longer output.",
3737
Example: "" +
38-
"arduino lib list # to show all installed library names.\n" +
39-
"arduino lib list -v # to show more details.",
38+
" " + commands.AppName + " lib list # to show all installed library names.\n" +
39+
" " + commands.AppName + " lib list -v # to show more details.",
4040
Args: cobra.NoArgs,
4141
Run: runListCommand,
4242
}

‎commands/lib/search.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ func initSearchCommand() *cobra.Command {
3434
Use: "search [LIBRARY_NAME]",
3535
Short: "Searchs for one or more libraries data.",
3636
Long: "Search for one or more libraries data (case insensitive search).",
37-
Example: "arduino lib search audio",
37+
Example: " " + commands.AppName + " lib search audio",
3838
Args: cobra.ArbitraryArgs,
3939
Run: runSearchCommand,
4040
}

‎commands/lib/uninstall.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ func initUninstallCommand() *cobra.Command {
3737
Use: "uninstall LIBRARY_NAME(S)",
3838
Short: "Uninstalls one or more libraries.",
3939
Long: "Uninstalls one or more libraries.",
40-
Example: "arduino lib uninstall AudioZero",
40+
Example: " " + commands.AppName + " lib uninstall AudioZero",
4141
Args: cobra.MinimumNArgs(1),
4242
Run: runUninstallCommand,
4343
}

‎commands/lib/update_index.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ func initUpdateIndexCommand() *cobra.Command {
2727
Use: "update-index",
2828
Short: "Updates the libraries index.",
2929
Long: "Updates the libraries index to the latest version.",
30-
Example: "arduino lib update-index",
30+
Example: " " + commands.AppName + " lib update-index",
3131
Args: cobra.NoArgs,
3232
Run: func(cmd *cobra.Command, args []string) {
3333
lm := commands.InitLibraryManager(nil)

‎commands/lib/upgrade.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ func initUpgradeCommand() *cobra.Command {
3030
Short: "Upgrades installed libraries.",
3131
Long: "This command ungrades all installed libraries to the latest available version." +
3232
"To upgrade a single library use the 'install' command.",
33-
Example: "arduino lib upgrade",
33+
Example: " " + commands.AppName + " lib upgrade",
3434
Args: cobra.NoArgs,
3535
Run: runUpgradeCommand,
3636
}

‎commands/root/root.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ func Init() *cobra.Command {
4545
Use: "arduino-cli",
4646
Short: "Arduino CLI.",
4747
Long: "Arduino Command Line Interface (arduino-cli).",
48-
Example: "arduino <command> [flags...]",
48+
Example: " " + commands.AppName + " <command> [flags...]",
4949
PersistentPreRun: preRun,
5050
}
5151
command.PersistentFlags().BoolVar(&commands.GlobalFlags.Debug, "debug", false, "Enables debug output (super verbose, used to debug the CLI).")

‎commands/sketch/new.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ func initNewCommand() *cobra.Command {
3030
Use: "new",
3131
Short: "Create a new Sketch",
3232
Long: "Create a new Sketch",
33-
Example: "arduino sketch new MultiBlinker",
33+
Example: " " + commands.AppName + " sketch new MultiBlinker",
3434
Args: cobra.ExactArgs(1),
3535
Run: runNewCommand,
3636
}

‎commands/sketch/sync.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ func initSyncCommand() *cobra.Command {
5353
Use: "sync",
5454
Short: "Arduino CLI Sketch Commands.",
5555
Long: "Arduino CLI Sketch Commands.",
56-
Example: "arduino sketch sync",
56+
Example: " " + commands.AppName + " sketch sync",
5757
Args: cobra.NoArgs,
5858
Run: runSyncCommand,
5959
}

0 commit comments

Comments
 (0)
Please sign in to comment.