feat: bash completion

fixes: #2707
TBD54566975 · Sep 19, 2024 · f3a4890 · f3a4890
1 parent ad00e7b
commit f3a4890
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 22 deletions.
diff --git a/frontend/cli/main.go b/frontend/cli/main.go
@@ -12,6 +12,7 @@ import (
 
 	"github.com/alecthomas/kong"
 	kongtoml "github.com/alecthomas/kong-toml"
+	kongcompletion "github.com/jotaen/kong-completion"
 
 	"github.com/TBD54566975/ftl"
 	"github.com/TBD54566975/ftl/backend/protos/xyz/block/ftl/v1/ftlv1connect"
@@ -32,27 +33,28 @@ type CLI struct {
 	Insecure       bool              `help:"Skip TLS certificate verification. Caution: susceptible to machine-in-the-middle attacks."`
 	Plain          bool              `help:"Use a plain console with no color or status line." env:"FTL_PLAIN"`
 
-	Interactive interactiveCmd `cmd:"" help:"Interactive mode." default:""`
-	Ping        pingCmd        `cmd:"" help:"Ping the FTL cluster."`
-	Status      statusCmd      `cmd:"" help:"Show FTL status."`
-	Init        initCmd        `cmd:"" help:"Initialize a new FTL project."`
-	New         newCmd         `cmd:"" help:"Create a new FTL module."`
-	Dev         devCmd         `cmd:"" help:"Develop FTL modules. Will start the FTL cluster, build and deploy all modules found in the specified directories, and watch for changes."`
-	PS          psCmd          `cmd:"" help:"List deployments."`
-	Serve       serveCmd       `cmd:"" help:"Start the FTL server."`
-	Call        callCmd        `cmd:"" help:"Call an FTL function."`
-	Update      updateCmd      `cmd:"" help:"Update a deployment."`
-	Kill        killCmd        `cmd:"" help:"Kill a deployment."`
-	Schema      schemaCmd      `cmd:"" help:"FTL schema commands."`
-	Build       buildCmd       `cmd:"" help:"Build all modules found in the specified directories."`
-	Box         boxCmd         `cmd:"" help:"Build a self-contained Docker container for running a set of module."`
-	BoxRun      boxRunCmd      `cmd:"" hidden:"" help:"Run FTL inside an ftl-in-a-box container"`
-	Deploy      deployCmd      `cmd:"" help:"Build and deploy all modules found in the specified directories."`
-	Migrate     migrateCmd     `cmd:"" help:"Run a database migration, if required, based on the migration table."`
-	Download    downloadCmd    `cmd:"" help:"Download a deployment."`
-	Secret      secretCmd      `cmd:"" help:"Manage secrets."`
-	Config      configCmd      `cmd:"" help:"Manage configuration."`
-	Pubsub      pubsubCmd      `cmd:"" help:"Manage pub/sub."`
+	Interactive interactiveCmd            `cmd:"" help:"Interactive mode." default:""`
+	Ping        pingCmd                   `cmd:"" help:"Ping the FTL cluster."`
+	Status      statusCmd                 `cmd:"" help:"Show FTL status."`
+	Init        initCmd                   `cmd:"" help:"Initialize a new FTL project."`
+	New         newCmd                    `cmd:"" help:"Create a new FTL module."`
+	Dev         devCmd                    `cmd:"" help:"Develop FTL modules. Will start the FTL cluster, build and deploy all modules found in the specified directories, and watch for changes."`
+	PS          psCmd                     `cmd:"" help:"List deployments."`
+	Serve       serveCmd                  `cmd:"" help:"Start the FTL server."`
+	Call        callCmd                   `cmd:"" help:"Call an FTL function."`
+	Update      updateCmd                 `cmd:"" help:"Update a deployment."`
+	Kill        killCmd                   `cmd:"" help:"Kill a deployment."`
+	Schema      schemaCmd                 `cmd:"" help:"FTL schema commands."`
+	Build       buildCmd                  `cmd:"" help:"Build all modules found in the specified directories."`
+	Box         boxCmd                    `cmd:"" help:"Build a self-contained Docker container for running a set of module."`
+	BoxRun      boxRunCmd                 `cmd:"" hidden:"" help:"Run FTL inside an ftl-in-a-box container"`
+	Deploy      deployCmd                 `cmd:"" help:"Build and deploy all modules found in the specified directories."`
+	Migrate     migrateCmd                `cmd:"" help:"Run a database migration, if required, based on the migration table."`
+	Download    downloadCmd               `cmd:"" help:"Download a deployment."`
+	Secret      secretCmd                 `cmd:"" help:"Manage secrets."`
+	Config      configCmd                 `cmd:"" help:"Manage configuration."`
+	Pubsub      pubsubCmd                 `cmd:"" help:"Manage pub/sub."`
+	Completion  kongcompletion.Completion `cmd:"" help:"Outputs shell code for initialising tab completions."`
 
 	// Specify the 1Password vault to access secrets from.
 	Vault string `name:"opvault" help:"1Password vault to be used for secrets. The name of the 1Password item will be the <ref> and the secret will be stored in the password field." placeholder:"VAULT"`
@@ -62,7 +64,8 @@ var cli CLI
 
 func main() {
 	ctx, cancel := context.WithCancel(context.Background())
-	kctx := kong.Parse(&cli,
+
+	app := kong.Must(&cli,
 		kong.Description(`FTL - Towards a 𝝺-calculus for large-scale systems`),
 		kong.Configuration(kongtoml.Loader, ".ftl.toml", "~/.ftl.toml"),
 		kong.ShortUsageOnError(),
@@ -81,6 +84,11 @@ func main() {
 			"numcpu":  strconv.Itoa(runtime.NumCPU()),
 		},
 	)
+	kongcompletion.Register(app)
+	kctx, err := app.Parse(os.Args[1:])
+	if err != nil {
+		panic(err)
+	}
 
 	if !cli.Plain {
 		sm := status.NewStatusManager(ctx)

diff --git a/go.mod b/go.mod
@@ -37,6 +37,7 @@ require (
 	github.com/jackc/pgerrcode v0.0.0-20240316143900-6e2875d9b438
 	github.com/jackc/pgx/v5 v5.7.1
 	github.com/jellydator/ttlcache/v3 v3.3.0
+	github.com/jotaen/kong-completion v0.0.6
 	github.com/jpillora/backoff v1.0.0
 	github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51
 	github.com/mattn/go-isatty v0.0.20
@@ -103,6 +104,8 @@ require (
 	github.com/google/go-cmp v0.6.0 // indirect
 	github.com/google/gofuzz v1.2.0 // indirect
 	github.com/gorilla/websocket v1.5.1 // indirect
+	github.com/hashicorp/errwrap v1.1.0 // indirect
+	github.com/hashicorp/go-multierror v1.1.1 // indirect
 	github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect
 	github.com/iancoleman/strcase v0.3.0 // indirect
 	github.com/imdario/mergo v0.3.13 // indirect
@@ -124,7 +127,9 @@ require (
 	github.com/petermattis/goid v0.0.0-20240813172612-4fcff4a6cae7 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pkoukk/tiktoken-go v0.1.6 // indirect
+	github.com/posener/complete v1.2.3 // indirect
 	github.com/rivo/uniseg v0.2.0 // indirect
+	github.com/riywo/loginshell v0.0.0-20200815045211-7d26008be1ab // indirect
 	github.com/sasha-s/go-deadlock v0.3.5 // indirect
 	github.com/segmentio/ksuid v1.0.4 // indirect
 	github.com/sourcegraph/jsonrpc2 v0.2.0 // indirect

diff --git a/go.sum b/go.sum