Add endless-scrolling TUI table for interactive list commands

cmd/root/io.go

@@ -49,6 +49,7 @@ func (f *outputFlag) initializeIO(ctx context.Context, cmd *cobra.Command) (cont
 
 	cmdIO := cmdio.NewIO(ctx, f.output, cmd.InOrStdin(), cmd.OutOrStdout(), cmd.ErrOrStderr(), headerTemplate, template)
 	ctx = cmdio.InContext(ctx, cmdIO)
+	ctx = cmdio.WithCommand(ctx, cmd)
 	cmd.SetContext(ctx)
 	return ctx, nil
 }

cmd/workspace/alerts/overrides.go

@@ -0,0 +1,32 @@
+package alerts
+
+import (
+	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/tableview"
+	"github.com/databricks/databricks-sdk-go/service/sql"
+	"github.com/spf13/cobra"
+)
+
+func listOverride(listCmd *cobra.Command, _ *sql.ListAlertsRequest) {
+	listCmd.Annotations["template"] = cmdio.Heredoc(`
+	{{range .}}{{green "%s" .Id}}	{{.DisplayName}}	{{.State}}
+	{{end}}`)
+
+	columns := []tableview.ColumnDef{
+		{Header: "ID", Extract: func(v any) string {
+			return v.(sql.ListAlertsResponseAlert).Id
+		}},
+		{Header: "Name", Extract: func(v any) string {
+			return v.(sql.ListAlertsResponseAlert).DisplayName
+		}},
+		{Header: "State", Extract: func(v any) string {
+			return string(v.(sql.ListAlertsResponseAlert).State)
+		}},
+	}
+
+	tableview.RegisterConfig(listCmd, tableview.TableConfig{Columns: columns})
+}
+
+func init() {
+	listOverrides = append(listOverrides, listOverride)
+}

cmd/workspace/apps/overrides.go

@@ -5,19 +5,47 @@ import (
 
 	appsCli "github.com/databricks/cli/cmd/apps"
 	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/tableview"
 	"github.com/databricks/databricks-sdk-go/service/apps"
 	"github.com/spf13/cobra"
 )
 
-func listOverride(listCmd *cobra.Command, listReq *apps.ListAppsRequest) {
+func listOverride(listCmd *cobra.Command, _ *apps.ListAppsRequest) {
 	listCmd.Annotations["headerTemplate"] = cmdio.Heredoc(`
 	{{header "Name"}}	{{header "Url"}}	{{header "ComputeStatus"}}	{{header "DeploymentStatus"}}`)
 	listCmd.Annotations["template"] = cmdio.Heredoc(`
 	{{range .}}{{.Name | green}}	{{.Url}}	{{if .ComputeStatus}}{{if eq .ComputeStatus.State "ACTIVE"}}{{green "%s" .ComputeStatus.State }}{{else}}{{blue "%s" .ComputeStatus.State}}{{end}}{{end}}	{{if .ActiveDeployment}}{{if eq .ActiveDeployment.Status.State "SUCCEEDED"}}{{green "%s" .ActiveDeployment.Status.State }}{{else}}{{blue "%s" .ActiveDeployment.Status.State}}{{end}}{{end}}
 	{{end}}`)
+
+	columns := []tableview.ColumnDef{
+		{Header: "Name", Extract: func(v any) string {
+			a := v.(apps.App)
+			return a.Name
+		}},
+		{Header: "URL", Extract: func(v any) string {
+			a := v.(apps.App)
+			return a.Url
+		}},
+		{Header: "Compute Status", Extract: func(v any) string {
+			a := v.(apps.App)
+			if a.ComputeStatus != nil {
+				return string(a.ComputeStatus.State)
+			}
+			return ""
+		}},
+		{Header: "Deploy Status", Extract: func(v any) string {
+			a := v.(apps.App)
+			if a.ActiveDeployment != nil && a.ActiveDeployment.Status != nil {
+				return string(a.ActiveDeployment.Status.State)
+			}
+			return ""
+		}},
+	}
+
+	tableview.RegisterConfig(listCmd, tableview.TableConfig{Columns: columns})
 }
 
-func listDeploymentsOverride(listDeploymentsCmd *cobra.Command, listDeploymentsReq *apps.ListAppDeploymentsRequest) {
+func listDeploymentsOverride(listDeploymentsCmd *cobra.Command, _ *apps.ListAppDeploymentsRequest) {
 	listDeploymentsCmd.Annotations["headerTemplate"] = cmdio.Heredoc(`
 	{{header "DeploymentId"}}	{{header "State"}}	{{header "CreatedAt"}}`)
 	listDeploymentsCmd.Annotations["template"] = cmdio.Heredoc(`

cmd/workspace/apps/overrides_test.go

@@ -0,0 +1,68 @@
+package apps
+
+import (
+	"testing"
+
+	"github.com/databricks/cli/libs/tableview"
+	sdkapps "github.com/databricks/databricks-sdk-go/service/apps"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestListTableConfig(t *testing.T) {
+	cmd := newList()
+
+	cfg := tableview.GetConfig(cmd)
+	require.NotNil(t, cfg)
+	require.Len(t, cfg.Columns, 4)
+
+	tests := []struct {
+		name        string
+		app         sdkapps.App
+		wantName    string
+		wantURL     string
+		wantCompute string
+		wantDeploy  string
+	}{
+		{
+			name: "with nested fields",
+			app: sdkapps.App{
+				Name: "test-app",
+				Url:  "https://example.com",
+				ComputeStatus: &sdkapps.ComputeStatus{
+					State: sdkapps.ComputeStateActive,
+				},
+				ActiveDeployment: &sdkapps.AppDeployment{
+					Status: &sdkapps.AppDeploymentStatus{
+						State: sdkapps.AppDeploymentStateSucceeded,
+					},
+				},
+			},
+			wantName:    "test-app",
+			wantURL:     "https://example.com",
+			wantCompute: "ACTIVE",
+			wantDeploy:  "SUCCEEDED",
+		},
+		{
+			name: "nil nested fields",
+			app: sdkapps.App{
+				Name:             "test-app",
+				Url:              "https://example.com",
+				ActiveDeployment: &sdkapps.AppDeployment{},
+			},
+			wantName:    "test-app",
+			wantURL:     "https://example.com",
+			wantCompute: "",
+			wantDeploy:  "",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			assert.Equal(t, tt.wantName, cfg.Columns[0].Extract(tt.app))
+			assert.Equal(t, tt.wantURL, cfg.Columns[1].Extract(tt.app))
+			assert.Equal(t, tt.wantCompute, cfg.Columns[2].Extract(tt.app))
+			assert.Equal(t, tt.wantDeploy, cfg.Columns[3].Extract(tt.app))
+		})
+	}
+}

cmd/workspace/catalogs/overrides.go

@@ -2,16 +2,31 @@ package catalogs
 
 import (
 	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/tableview"
 	"github.com/databricks/databricks-sdk-go/service/catalog"
 	"github.com/spf13/cobra"
 )
 
-func listOverride(listCmd *cobra.Command, listReq *catalog.ListCatalogsRequest) {
+func listOverride(listCmd *cobra.Command, _ *catalog.ListCatalogsRequest) {
 	listCmd.Annotations["headerTemplate"] = cmdio.Heredoc(`
 	{{header "Name"}}	{{header "Type"}}	{{header "Comment"}}`)
 	listCmd.Annotations["template"] = cmdio.Heredoc(`
 	{{range .}}{{.Name|green}}	{{blue "%s" .CatalogType}}	{{.Comment}}
 	{{end}}`)
+
+	columns := []tableview.ColumnDef{
+		{Header: "Name", Extract: func(v any) string {
+			return v.(catalog.CatalogInfo).Name
+		}},
+		{Header: "Type", Extract: func(v any) string {
+			return string(v.(catalog.CatalogInfo).CatalogType)
+		}},
+		{Header: "Comment", MaxWidth: 40, Extract: func(v any) string {
+			return v.(catalog.CatalogInfo).Comment
+		}},
+	}
+
+	tableview.RegisterConfig(listCmd, tableview.TableConfig{Columns: columns})
 }
 
 func init() {

cmd/workspace/cluster-policies/overrides.go

@@ -2,6 +2,7 @@ package cluster_policies
 
 import (
 	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/tableview"
 	"github.com/databricks/databricks-sdk-go/service/compute"
 	"github.com/spf13/cobra"
 )
@@ -10,6 +11,23 @@ func listOverride(listCmd *cobra.Command, _ *compute.ListClusterPoliciesRequest)
 	listCmd.Annotations["template"] = cmdio.Heredoc(`
 	{{range .}}{{.PolicyId | green}}	{{.Name}}
 	{{end}}`)
+
+	columns := []tableview.ColumnDef{
+		{Header: "Policy ID", Extract: func(v any) string {
+			return v.(compute.Policy).PolicyId
+		}},
+		{Header: "Name", Extract: func(v any) string {
+			return v.(compute.Policy).Name
+		}},
+		{Header: "Default", Extract: func(v any) string {
+			if v.(compute.Policy).IsDefault {
+				return "yes"
+			}
+			return ""
+		}},
+	}
+
+	tableview.RegisterConfig(listCmd, tableview.TableConfig{Columns: columns})
 }
 
 func getOverride(getCmd *cobra.Command, _ *compute.GetClusterPolicyRequest) {

cmd/workspace/clusters/overrides.go

@@ -4,6 +4,7 @@ import (
 	"strings"
 
 	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/tableview"
 	"github.com/databricks/databricks-sdk-go/service/compute"
 	"github.com/spf13/cobra"
 )
@@ -17,6 +18,20 @@ func listOverride(listCmd *cobra.Command, listReq *compute.ListClustersRequest)
 	{{range .}}{{.ClusterId | green}}	{{.ClusterName | cyan}}	{{if eq .State "RUNNING"}}{{green "%s" .State}}{{else if eq .State "TERMINATED"}}{{red "%s" .State}}{{else}}{{blue "%s" .State}}{{end}}
 	{{end}}`)
 
+	columns := []tableview.ColumnDef{
+		{Header: "Cluster ID", Extract: func(v any) string {
+			return v.(compute.ClusterDetails).ClusterId
+		}},
+		{Header: "Name", Extract: func(v any) string {
+			return v.(compute.ClusterDetails).ClusterName
+		}},
+		{Header: "State", Extract: func(v any) string {
+			return string(v.(compute.ClusterDetails).State)
+		}},
+	}
+
+	tableview.RegisterConfig(listCmd, tableview.TableConfig{Columns: columns})
+
 	listReq.FilterBy = &compute.ListClustersFilterBy{}
 	listCmd.Flags().BoolVar(&listReq.FilterBy.IsPinned, "is-pinned", false, "Filter clusters by pinned status")
 	listCmd.Flags().StringVar(&listReq.FilterBy.PolicyId, "policy-id", "", "Filter clusters by policy id")

cmd/workspace/external-locations/overrides.go

@@ -2,16 +2,31 @@ package external_locations
 
 import (
 	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/tableview"
 	"github.com/databricks/databricks-sdk-go/service/catalog"
 	"github.com/spf13/cobra"
 )
 
-func listOverride(listCmd *cobra.Command, listReq *catalog.ListExternalLocationsRequest) {
+func listOverride(listCmd *cobra.Command, _ *catalog.ListExternalLocationsRequest) {
 	listCmd.Annotations["headerTemplate"] = cmdio.Heredoc(`
 	{{header "Name"}}	{{header "Credential"}}	{{header "URL"}}`)
 	listCmd.Annotations["template"] = cmdio.Heredoc(`
 	{{range .}}{{.Name|green}}	{{.CredentialName|cyan}}	{{.Url}}
 	{{end}}`)
+
+	columns := []tableview.ColumnDef{
+		{Header: "Name", Extract: func(v any) string {
+			return v.(catalog.ExternalLocationInfo).Name
+		}},
+		{Header: "Credential", Extract: func(v any) string {
+			return v.(catalog.ExternalLocationInfo).CredentialName
+		}},
+		{Header: "URL", Extract: func(v any) string {
+			return v.(catalog.ExternalLocationInfo).Url
+		}},
+	}
+
+	tableview.RegisterConfig(listCmd, tableview.TableConfig{Columns: columns})
 }
 
 func init() {

cmd/workspace/instance-pools/overrides.go

@@ -2,13 +2,32 @@ package instance_pools
 
 import (
 	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/tableview"
+	"github.com/databricks/databricks-sdk-go/service/compute"
 	"github.com/spf13/cobra"
 )
 
 func listOverride(listCmd *cobra.Command) {
 	listCmd.Annotations["template"] = cmdio.Heredoc(`
 	{{range .}}{{.InstancePoolId|green}}	{{.InstancePoolName}}	{{.NodeTypeId}}	{{.State}}
 	{{end}}`)
+
+	columns := []tableview.ColumnDef{
+		{Header: "Pool ID", Extract: func(v any) string {
+			return v.(compute.InstancePoolAndStats).InstancePoolId
+		}},
+		{Header: "Name", Extract: func(v any) string {
+			return v.(compute.InstancePoolAndStats).InstancePoolName
+		}},
+		{Header: "Node Type", Extract: func(v any) string {
+			return v.(compute.InstancePoolAndStats).NodeTypeId
+		}},
+		{Header: "State", Extract: func(v any) string {
+			return string(v.(compute.InstancePoolAndStats).State)
+		}},
+	}
+
+	tableview.RegisterConfig(listCmd, tableview.TableConfig{Columns: columns})
 }
 
 func init() {

cmd/workspace/jobs/overrides.go

@@ -1,7 +1,12 @@
 package jobs
 
 import (
+	"context"
+	"strconv"
+
+	"github.com/databricks/cli/libs/cmdctx"
 	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/tableview"
 	"github.com/databricks/databricks-sdk-go/service/jobs"
 	"github.com/spf13/cobra"
 )
@@ -10,9 +15,36 @@ func listOverride(listCmd *cobra.Command, listReq *jobs.ListJobsRequest) {
 	listCmd.Annotations["template"] = cmdio.Heredoc(`
 	{{range .}}{{green "%d" .JobId}}	{{.Settings.Name}}
 	{{end}}`)
+
+	columns := []tableview.ColumnDef{
+		{Header: "Job ID", Extract: func(v any) string {
+			return strconv.FormatInt(v.(jobs.BaseJob).JobId, 10)
+		}},
+		{Header: "Name", Extract: func(v any) string {
+			if v.(jobs.BaseJob).Settings != nil {
+				return v.(jobs.BaseJob).Settings.Name
+			}
+			return ""
+		}},
+	}
+
+	tableview.RegisterConfig(listCmd, tableview.TableConfig{
+		Columns: columns,
+		Search: &tableview.SearchConfig{
+			Placeholder: "Search by exact name...",
+			NewIterator: func(ctx context.Context, query string) tableview.RowIterator {
+				req := *listReq
+				req.Name = query
+				req.PageToken = ""
+				req.Offset = 0
+				w := cmdctx.WorkspaceClient(ctx)
+				return tableview.WrapIterator(w.Jobs.List(ctx, req), columns)
+			},
+		},
+	})
 }
 
-func listRunsOverride(listRunsCmd *cobra.Command, listRunsReq *jobs.ListRunsRequest) {
+func listRunsOverride(listRunsCmd *cobra.Command, _ *jobs.ListRunsRequest) {
 	listRunsCmd.Annotations["headerTemplate"] = cmdio.Heredoc(`
 	{{header "Job ID"}}	{{header "Run ID"}}	{{header "Result State"}}	URL`)
 	listRunsCmd.Annotations["template"] = cmdio.Heredoc(`