[LocalCLI] add completion for --class and --editor flags

components/local-app/BUILD.yaml

@@ -13,3 +13,13 @@ packages:
       image:
         - ${imageRepoBase}/local-app:${version}
         - ${imageRepoBase}/local-app:commit-${__git_commit}
+
+scripts:
+  - name: install-cli
+    description: "Install gitpod-cli as gitpod command and add auto-completion. Usage: '. $(leeway run components/local-app:install-cli)'"
+    script: |
+      go build -o gitpod ./main/gitpod-cli
+      sudo mv gitpod /usr/bin/gitpod
+      sudo chmod +x /usr/bin/gitpod
+      # pipe completion
+      sudo /usr/bin/gitpod completion bash | sudo tee /usr/share/bash-completion/completions/gitpod

components/local-app/cmd/root.go

@@ -101,7 +101,13 @@ var rootTestingOpts struct {
 	WriterOut io.Writer
 }
 
+var clientCache *client.Gitpod
+
 func getGitpodClient(ctx context.Context) (*client.Gitpod, error) {
+	// There will be only one client in a command context right now
+	if clientCache != nil {
+		return clientCache, nil
+	}
 	cfg := config.FromContext(ctx)
 	gpctx, err := cfg.GetActiveContext()
 	if err != nil {
@@ -154,6 +160,7 @@ func getGitpodClient(ctx context.Context) (*client.Gitpod, error) {
 	if err != nil {
 		return nil, err
 	}
+	clientCache = res
 
 	return res, nil
 }

components/local-app/cmd/workspace-create.go

@@ -143,10 +143,53 @@ var workspaceCreateOpts struct {
 	Editor         string
 }
 
+func classCompletionFunc(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+	ctx := cmd.Context()
+	gitpod, err := getGitpodClient(ctx)
+	if err != nil {
+		return nil, cobra.ShellCompDirectiveError
+	}
+	resp, err := gitpod.Workspaces.ListWorkspaceClasses(ctx, connect.NewRequest(&v1.ListWorkspaceClassesRequest{}))
+	if err != nil {
+		return nil, cobra.ShellCompDirectiveError
+	}
+	items := resp.Msg.GetResult()
+	completionStr := []string{}
+	for _, cls := range items {
+		defaultDesc := ""
+		if cls.IsDefault {
+			defaultDesc = "(default)"
+		}
+		completionStr = append(completionStr, fmt.Sprintf("%s\t%s%s - %s", cls.Id, cls.DisplayName, defaultDesc, cls.Description))
+	}
+	return completionStr, cobra.ShellCompDirectiveNoFileComp
+}
+
+func editorCompletionFunc(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+	ctx := cmd.Context()
+	gitpod, err := getGitpodClient(ctx)
+	if err != nil {
+		return nil, cobra.ShellCompDirectiveError
+	}
+	resp, err := gitpod.Editors.ListEditorOptions(ctx, connect.NewRequest(&v1.ListEditorOptionsRequest{}))
+	if err != nil {
+		return nil, cobra.ShellCompDirectiveError
+	}
+	items := resp.Msg.GetResult()
+	completionStr := []string{}
+	for _, editor := range items {
+		completionStr = append(completionStr, fmt.Sprintf("%s\t%s", editor.Id, editor.Title))
+	}
+	return completionStr, cobra.ShellCompDirectiveNoFileComp
+}
+
 func init() {
 	workspaceCmd.AddCommand(workspaceCreateCmd)
 	addWorkspaceStartOptions(workspaceCreateCmd, &workspaceCreateOpts.StartOpts)
 
 	workspaceCreateCmd.Flags().StringVar(&workspaceCreateOpts.WorkspaceClass, "class", "", "the workspace class")
 	workspaceCreateCmd.Flags().StringVar(&workspaceCreateOpts.Editor, "editor", "code", "the editor to use")
+
+	_ = workspaceCreateCmd.RegisterFlagCompletionFunc("class", classCompletionFunc)
+	_ = workspaceCreateCmd.RegisterFlagCompletionFunc("editor", editorCompletionFunc)
 }