Add examples for cli commands

Signed-off-by: Paulo Gomes <[email protected]>

Author: pjbgf

cmd/cli/clipboard.go

@@ -30,6 +30,12 @@ func clipboardCommand() *cli.Command {
 			{
 				Name:  "from-host",
 				Usage: "copies the clipboard contents from the host to a profile",
+				Description: `Examples:
+
+qubesome clip from-host                        - Copy clipboard contents from host to the active profile
+qubesome clip from-host -type image/png        - Copy image from host clipboard to the active profile
+qubesome clip from-host -profile <name>        - Copy clipboard contents from host to a specific profile
+`,
 				Arguments: []cli.Argument{
 					&cli.StringArg{
 						Name:        "target_profile",
@@ -54,7 +60,6 @@ func clipboardCommand() *cli.Command {
 					}
 
 					if typ := c.String("type"); typ != "" {
-						fmt.Println(typ)
 						opts = append(opts, clipboard.WithContentType(typ))
 					}
 
@@ -102,7 +107,6 @@ func clipboardCommand() *cli.Command {
 					}
 
 					if typ := c.String("type"); typ != "" {
-						fmt.Println(typ)
 						opts = append(opts, clipboard.WithContentType(typ))
 					}
 
@@ -114,6 +118,12 @@ func clipboardCommand() *cli.Command {
 			{
 				Name:  "to-host",
 				Usage: "copies the clipboard contents from a profile to the host",
+				Description: `Examples:
+
+qubesome clip to-host                        - Copy clipboard contents from the active profile to the host
+qubesome clip to-host -type image/png        - Copy image from the active profile clipboard to the host
+qubesome clip to-host -profile <name>        - Copy clipboard contents from a specific profile to the host
+				`,
 				Arguments: []cli.Argument{
 					&cli.StringArg{
 						Name:        "source_profile",

cmd/cli/host_run.go

@@ -13,6 +13,11 @@ func hostRunCommand() *cli.Command {
 		Name:    "host-run",
 		Aliases: []string{"hr"},
 		Usage:   "Runs a command at the host, but shows it in a given qubesome profile",
+		Description: `Examples:
+
+qubesome host-run firefox                        - Run firefox on the host and display it on the active profile
+qubesome host-run -profile <profile> firefox     - Run firefox on the host and display it on a specific profile
+`,
 		Arguments: []cli.Argument{
 			&cli.StringArg{
 				Name:        "command",

cmd/cli/run.go

@@ -11,6 +11,12 @@ func runCommand() *cli.Command {
 	cmd := &cli.Command{
 		Name:    "run",
 		Aliases: []string{"r"},
+		Usage:   "execute workloads",
+		Description: `Examples:
+
+qubesome run chrome                        - Run the chrome workload on the active profile
+qubesome run -profile <profile> chrome     - Run the chrome workload on a specific profile
+`,
 		Arguments: []cli.Argument{
 			&cli.StringArg{
 				Name:        "workload",
@@ -29,13 +35,17 @@ func runCommand() *cli.Command {
 				Destination: &runner,
 			},
 		},
-		Usage: "execute workloads",
 		Action: func(ctx context.Context, cmd *cli.Command) error {
-			cfg := profileConfigOrDefault(targetProfile)
+			prof, err := profileOrActive(targetProfile)
+			if err != nil {
+				return err
+			}
+
+			cfg := profileConfigOrDefault(prof.Name)
 
 			return qubesome.Run(
 				qubesome.WithWorkload(workload),
-				qubesome.WithProfile(targetProfile),
+				qubesome.WithProfile(prof.Name),
 				qubesome.WithConfig(cfg),
 				qubesome.WithRunner(runner),
 				qubesome.WithExtraArgs(cmd.Args().Slice()),

cmd/cli/start.go

@@ -11,6 +11,12 @@ func startCommand() *cli.Command {
 	cmd := &cli.Command{
 		Name:    "start",
 		Aliases: []string{"s"},
+		Usage:   "start qubesome profiles",
+		Description: `Examples:
+
+qubesome start -git https://github.com/qubesome/sample-dotfiles awesome
+qubesome start -git https://github.com/qubesome/sample-dotfiles i3
+`,
 		Flags: []cli.Flag{
 			&cli.StringFlag{
 				Name:        "git",
@@ -40,7 +46,6 @@ func startCommand() *cli.Command {
 				Destination: &targetProfile,
 			},
 		},
-		Usage: "start qubesome profiles",
 		Action: func(ctx context.Context, cmd *cli.Command) error {
 			cfg := profileConfigOrDefault(targetProfile)
 

cmd/cli/xdg.go

@@ -12,6 +12,11 @@ func xdgCommand() *cli.Command {
 		Name:    "xdg-open",
 		Aliases: []string{"xdg"},
 		Usage:   "opens a file or URL in the user's configured workload",
+		Description: `Examples:
+
+qubesome xdg-open https://github.com/qubesome                       - Opens the URL on the workload defined on the active qubesome config
+qubesome xdg-open -profile <profile> https://github.com/qubesome    - Opens the URL on the workload defined on the given profile's qubesome config
+`,
 		Flags: []cli.Flag{
 			&cli.StringFlag{
 				Name:        "profile",
@@ -23,7 +28,12 @@ func xdgCommand() *cli.Command {
 			},
 		},
 		Action: func(ctx context.Context, cmd *cli.Command) error {
-			cfg := profileConfigOrDefault(targetProfile)
+			prof, err := profileOrActive(targetProfile)
+			if err != nil {
+				return err
+			}
+
+			cfg := profileConfigOrDefault(prof.Name)
 
 			return qubesome.XdgRun(
 				qubesome.WithConfig(cfg),