Update command flags, add new --from flag for 'label copy'

Improve README. These changes make it easier to use the tool.

Fixes #5 further more.

Author: clns

README.md

@@ -1,10 +1,14 @@
 # gitlab-cli [![Build Status](https://travis-ci.org/clns/gitlab-cli.svg?branch=master)](https://travis-ci.org/clns/gitlab-cli)
 
-CLI commands for performing actions against GitLab repositories. The main reasons for building this tool is to be able to use it without any prerequisites and to deal with global labels, which GitLab API doesn't expose.
+CLI commands for performing actions against GitLab repositories.
 
 - [Installation](#installation)
 - [Usage](#usage)
   - [Labels](#labels)
+    - [Copy global labels](#copy-global-labels-into-a-repository)
+    - [Copy labels from repoA to repoB](#copy-labels-from-repoa-to-repob)
+    - [Update labels](#update-labels-that-match-a-regex)
+    - [Delete labels](#delete-labels-that-match-a-regex)
   - [Specifying a repository](#specifying-a-repository)
   - [The config file](#the-config-file)
 - [Development](#development)
@@ -32,31 +36,23 @@ gitlab-cli label copy -U https://gitlab.com/<USER>/<REPO> -t <TOKEN>
 #### Copy labels from repoA to repoB
 
 ```sh
-gitlab-cli label copy -r <NAME> <GROUP>/<REPO>
+gitlab-cli label copy --from <repoA> -r <repoB>
 ```
 
-> Tip: The above command copies labels between repositories on the same GitLab instance. To copy from/to a different GitLab instance, use the config file as explained in [Specifying a repository](#specifying-a-repository).
-
-##### Example
-
-If both repositories are added to the [config file](#specifying-a-repository) as `repoA` and `repoB`, you can copy labels from repoA to repoB as follows:
- 
-```sh
-gitlab-cli label copy -r repoB repoA
-```
+> Tip: For repositories on the same installation, you can specify the `--from` repo as `group/repo`, as a convenience, in which case the repository is considered on the same GitLab instance as the target repo.
 
 #### Update labels that match a regex
 
 ```sh
-gitlab-cli label update -r <NAME> --match <REGEX> --replace <REPLACE> --color <COLOR>
+gitlab-cli label update -r <NAME> --match <REGEX> --name <NAME> --color <COLOR> --description <DESC>
 ```
 
-> Note: `<REGEX>` is a Go regex string as in <https://golang.org/pkg/regexp/syntax> and `<REPLACE>` is a replacement string as in <https://golang.org/pkg/regexp/#Regexp.FindAllString>.
+> Note: `<REGEX>` is a Go regex string as in <https://golang.org/pkg/regexp/syntax> and `<NAME>` is a replacement string as in <https://golang.org/pkg/regexp/#Regexp.FindAllString>.
 
 #### Delete labels that match a regex
 
 ```sh
-gitlab-cli label update -r <NAME> --regex <REGEX>
+gitlab-cli label delete -r <NAME> --match <REGEX>
 ```
 
 ### TODO
@@ -72,19 +68,19 @@ There are 2 ways to specify a repository:
 
 Example:
 
+Instead of this:
+
 ```sh
 gitlab-cli label copy -U https://git.my-site.com/my_group/my_repo -t ghs93hska
 ```
 
-is the same as this, but the repo gets saved in the config file and we can refer to it later by its name:
+you can first save the repo in the config file and refer to it by name on all subsequent commands:
 
 ```sh
 gitlab-cli config repo save -r myrepo -U https://git.my-site.com/my_group/my_repo -t ghs93hska
 gitlab-cli label copy -r myrepo
 ```
 
-> Note: Some commands like [`label copy`](#copy-labels-from-one-repository-to-another) allow you to specify a repository by its path (e.g. `my_group/my_repo`), in which case the repository is considered on the same GitLab instance as the target repo.
-
 #### Using user and password instead of token
 
 You can specify your GitLab login (user or email) - `--user (-u)` - and password - `--password (-p)` - instead of the token in any command, if this is easier for you. Example:

cmd/label_copy.go

@@ -7,42 +7,34 @@ import (
 	"github.com/spf13/cobra"
 )
 
+var fromRepo string
+
 var labelCopyCmd = &cobra.Command{
-	Use:     "copy [<from-repo>]",
+	Use:     "copy",
 	Aliases: []string{"c"},
 	Short:   "Copy labels into a repository",
 	Long: `Copy labels into a repository.
 
-If given without an argument, it will copy global labels. If <from-repo>
-is specified, it will copy all labels from that repository. This argument
-can be a repo name as in the config file or a path (e.g. 'myuser/myrepo').
-In the later case it will use --url, without its path.`,
-	Example: `  $ gitlab label copy -U https://gitlab.com/user/myrepo -t <TOKEN>
-  # = copy global labels into 'user/myrepo'
+If --from is omitted, it will copy global labels. If --from is specified,
+it will copy all labels from that repository.
 
-  $ gitlab label copy -r myrepo myotherrepo
-  # = copy labels from 'myotherrepo' into 'myrepo'`,
+The from repo can be a repo name as in the config file or a relative path
+as group/repo (e.g. 'myuser/myrepo'). In the later case it will use the url
+of the target repo, so the repositories need to be on the same GitLab instance.`,
+	Example: `  $ gitlab label copy -U https://gitlab.com/user/myrepo -t <TOKEN>
+  $ gitlab label copy --from sourceRepo -r targetRepo
+  $ gitlab label copy --from group/repo -r targetRepo`,
 	Run: func(cmd *cobra.Command, args []string) {
-		if len(args) > 1 {
-			fmt.Fprintln(os.Stderr, "error: invalid arguments")
-			cmd.Usage()
-			os.Exit(2)
-		}
 		var (
 			from, to *Repo
 			err      error
 		)
-		if len(args) == 0 {
-			if to, err = LoadFromConfig(repo); err != nil {
-				fmt.Fprintf(os.Stderr, "error: invalid target repository: %v\n", err.Error())
-				os.Exit(1)
-			}
-		} else if len(args) == 1 {
-			if to, err = LoadFromConfig(repo); err != nil {
-				fmt.Fprintf(os.Stderr, "error: invalid target repository: %v\n", err.Error())
-				os.Exit(1)
-			}
-			if from, err = LoadFromConfig(args[0]); err != nil {
+		if to, err = LoadFromConfig(repo); err != nil {
+			fmt.Fprintf(os.Stderr, "error: invalid target repository: %v\n", err.Error())
+			os.Exit(1)
+		}
+		if fromRepo != "" {
+			if from, err = LoadFromConfig(fromRepo); err != nil {
 				fmt.Fprintf(os.Stderr, "error: invalid source repository: %v\n", err.Error())
 				os.Exit(1)
 			}
@@ -68,4 +60,6 @@ In the later case it will use --url, without its path.`,
 
 func init() {
 	labelCmd.AddCommand(labelCopyCmd)
+
+	labelCopyCmd.Flags().StringVar(&fromRepo, "from", "", "Source repository (optional)")
 }

cmd/label_delete.go

@@ -15,10 +15,10 @@ var labelDeleteCmd = &cobra.Command{
 	Short:   "Delete labels from a repository",
 	Long: `Delete labels from a repository.
 
-The --regex flag can be specified as a Go regexp pattern to delete only
+The --match flag can be specified as a Go regexp pattern to delete only
 labels that match. If ommitted, all repository labels will be deleted.`,
 	Example: `  $ gitlab label delete -r myrepo
-  $ gitlab label delete -r myrepo --regexp=".*:.*"`,
+  $ gitlab label delete -r myrepo --match=".*:.*"`,
 	Run: func(cmd *cobra.Command, args []string) {
 		var (
 			to  *Repo
@@ -39,5 +39,5 @@ labels that match. If ommitted, all repository labels will be deleted.`,
 func init() {
 	labelCmd.AddCommand(labelDeleteCmd)
 
-	labelDeleteCmd.Flags().StringVar(&regexpLabel, "regex", "", "Label name to match, as a Go regex (https://golang.org/pkg/regexp/syntax)")
+	labelDeleteCmd.Flags().StringVar(&regexpLabel, "match", "", "Label name to match, as a Go regex (https://golang.org/pkg/regexp/syntax)")
 }

cmd/label_update.go

@@ -20,8 +20,8 @@ var labelUpdateCmd = &cobra.Command{
 	Long: `Update labels in a repository.
 
 The --match flag is required and is a Go regex that will be used to match the label
-name. At least one of --replace or --color is required to update the label(s).`,
-	Example: `  $ gitlab label update -r myrepo --match "(.*):(.*)" --replace "${1}/${2}"`,
+name. At least one of --name, --color or --description is required to update the label(s).`,
+	Example: `  $ gitlab label update -r myrepo --match "(.*):(.*)" --name "${1}/${2}"`,
 	Run: func(cmd *cobra.Command, args []string) {
 		var (
 			to  *Repo
@@ -48,7 +48,7 @@ func init() {
 	labelCmd.AddCommand(labelUpdateCmd)
 
 	labelUpdateCmd.Flags().StringVar(&matchLabel, "match", "", "Label name to match, as a Go regex (https://golang.org/pkg/regexp/syntax)")
-	labelUpdateCmd.Flags().StringVar(&replaceLabel, "replace", "", "Label name replacement (https://golang.org/pkg/regexp/#Regexp.FindAllString)")
+	labelUpdateCmd.Flags().StringVar(&replaceLabel, "name", "", "Label name (https://golang.org/pkg/regexp/#Regexp.FindAllString)")
 	labelUpdateCmd.Flags().StringVar(&colorLabel, "color", "", "Label color (e.g. '#000000')")
 	labelUpdateCmd.Flags().StringVar(&descriptionLabel, "description", "", "Label description")
 }

cmd/root.go

@@ -22,7 +22,7 @@ var (
 // RootCmd represents the base command when called without any subcommands
 var RootCmd = &cobra.Command{
 	Use:   "gitlab-cli",
-	Short: "GitLab CLI tool",
+	Short: "Cli tool for performing actions against GitLab repositories",
 	// Uncomment the following line if your bare application
 	// has an action associated with it:
 	//	Run: func(cmd *cobra.Command, args []string) { },

cmd/update.go

@@ -19,6 +19,9 @@ var updateCmd = &cobra.Command{
 	Use:     "update",
 	Aliases: []string{"u"},
 	Short:   "Update this tool to the latest version",
+	Long: `Update this tool to the latest version.
+
+You might need to run this command with sudo.`,
 	Run: func(cmd *cobra.Command, args []string) {
 		rel, err := getLatestRelease()
 		if err != nil {
@@ -137,7 +140,11 @@ func CheckUpdate() {
 
 func printUpdateAvl(latest string) {
 	if latest != Version {
-		fmt.Printf("New update available: %s. Run 'gitlab-cli update' to update.\n", latest)
+		if runtime.GOOS == "linux" {
+			fmt.Printf("New update available: %s. Run 'sudo gitlab-cli update' to update.\n", latest)
+		} else {
+			fmt.Printf("New update available: %s. Run 'gitlab-cli update' to update.\n", latest)
+		}
 	}
 }