Refine AWS profile setup flow

Author: gtsiolis

CLAUDE.md

@@ -55,6 +55,14 @@ When adding a new command that depends on configuration, wire config initializat
 
 Created automatically on first run with defaults. Supports emulator types (aws, snowflake, azure) - currently only aws is implemented.
 
+# Emulator Setup Commands
+
+Use `lstk setup <emulator>` to set up CLI integration for an emulator type:
+- `lstk setup aws` — Sets up AWS CLI profile in `~/.aws/config` and `~/.aws/credentials`
+
+This naming avoids AWS-specific "profile" terminology and uses a clear verb for mutation operations.
+The deprecated `lstk config profile` command still works but points users to `lstk setup aws`.
+
 Environment variables:
 - `LOCALSTACK_AUTH_TOKEN` - Auth token (skips browser login if set)
 

cmd/config.go

@@ -6,6 +6,7 @@ import (
 	"github.com/localstack/lstk/internal/config"
 	"github.com/localstack/lstk/internal/env"
 	"github.com/localstack/lstk/internal/telemetry"
+	"github.com/localstack/lstk/internal/ui"
 	"github.com/spf13/cobra"
 )
 
@@ -14,10 +15,31 @@ func newConfigCmd(cfg *env.Env, tel *telemetry.Client) *cobra.Command {
 		Use:   "config",
 		Short: "Manage configuration",
 	}
+	cmd.AddCommand(newConfigProfileCmd(cfg, tel))
 	cmd.AddCommand(newConfigPathCmd(cfg, tel))
 	return cmd
 }
 
+func newConfigProfileCmd(cfg *env.Env, tel *telemetry.Client) *cobra.Command {
+	return &cobra.Command{
+		Use:     "profile",
+		Short:   "Deprecated: use 'lstk setup aws' instead",
+		PreRunE: initConfig,
+		RunE: commandWithTelemetry("config profile", tel, func(cmd *cobra.Command, args []string) error {
+			appConfig, err := config.Get()
+			if err != nil {
+				return fmt.Errorf("failed to get config: %w", err)
+			}
+
+			if !isInteractiveMode(cfg) {
+				return fmt.Errorf("config profile requires an interactive terminal")
+			}
+
+			return ui.RunConfigProfile(cmd.Context(), appConfig.Containers, cfg.LocalStackHost)
+		}),
+	}
+}
+
 func newConfigPathCmd(cfg *env.Env, tel *telemetry.Client) *cobra.Command {
 	return &cobra.Command{
 		Use:   "path",

cmd/root.go

@@ -59,6 +59,7 @@ func NewRootCmd(cfg *env.Env, tel *telemetry.Client, logger log.Logger) *cobra.C
 		newLogoutCmd(cfg, tel, logger),
 		newStatusCmd(cfg, tel),
 		newLogsCmd(cfg, tel),
+		newSetupCmd(cfg, tel),
 		newConfigCmd(cfg, tel),
 		newUpdateCmd(cfg, tel),
 	)

cmd/setup.go

@@ -0,0 +1,42 @@
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/localstack/lstk/internal/config"
+	"github.com/localstack/lstk/internal/env"
+	"github.com/localstack/lstk/internal/telemetry"
+	"github.com/localstack/lstk/internal/ui"
+	"github.com/spf13/cobra"
+)
+
+func newSetupCmd(cfg *env.Env, tel *telemetry.Client) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "setup",
+		Short: "Set up emulator CLI integration",
+		Long:  "Set up emulator CLI integration (e.g., AWS profile, Azure config).",
+	}
+	cmd.AddCommand(newSetupAWSCmd(cfg, tel))
+	return cmd
+}
+
+func newSetupAWSCmd(cfg *env.Env, tel *telemetry.Client) *cobra.Command {
+	return &cobra.Command{
+		Use:     "aws",
+		Short:   "Set up the LocalStack AWS profile",
+		Long:    "Set up the LocalStack AWS profile in ~/.aws/config and ~/.aws/credentials for use with AWS CLI and SDKs.",
+		PreRunE: initConfig,
+		RunE: commandWithTelemetry("setup aws", tel, func(cmd *cobra.Command, args []string) error {
+			appConfig, err := config.Get()
+			if err != nil {
+				return fmt.Errorf("failed to get config: %w", err)
+			}
+
+			if !isInteractiveMode(cfg) {
+				return fmt.Errorf("setup aws requires an interactive terminal")
+			}
+
+			return ui.RunConfigProfile(cmd.Context(), appConfig.Containers, cfg.LocalStackHost)
+		}),
+	}
+}

internal/awsconfig/awsconfig.go

@@ -184,17 +184,47 @@ func writeCredsProfile(credsPath string) error {
 	return upsertSection(credsPath, credsSectionName, credentialsDefaults())
 }
 
-// Setup checks for the localstack AWS profile and prompts to create or update it if needed.
-// resolvedHost must be a host:port string (e.g. "localhost.localstack.cloud:4566").
-// In non-interactive mode, emits a note instead of prompting.
-func Setup(ctx context.Context, sink output.Sink, interactive bool, resolvedHost string) error {
+func emitMissingProfileNote(sink output.Sink) {
+	output.EmitNote(sink, "LocalStack AWS profile is incomplete. Run 'lstk setup aws'.")
+}
+
+func needsProfileSetup(resolvedHost string) (profileStatus, error) {
 	configPath, credsPath, err := awsPaths()
 	if err != nil {
-		output.EmitWarning(sink, fmt.Sprintf("could not determine AWS config paths: %v", err))
-		return nil
+		return profileStatus{}, err
 	}
 
 	status, err := checkProfileStatus(configPath, credsPath, resolvedHost)
+	if err != nil {
+		return profileStatus{}, err
+	}
+
+	return status, nil
+}
+
+func profilePresence() (configOK, credsOK bool, err error) {
+	configPath, credsPath, err := awsPaths()
+	if err != nil {
+		return false, false, err
+	}
+
+	configOK, err = sectionExists(configPath, configSectionName)
+	if err != nil {
+		return false, false, err
+	}
+	credsOK, err = sectionExists(credsPath, credsSectionName)
+	if err != nil {
+		return false, false, err
+	}
+
+	return configOK, credsOK, nil
+}
+
+// EnsureProfile checks for the LocalStack AWS profile and either emits a note when it is incomplete
+// or triggers the interactive setup flow.
+// resolvedHost must be a host:port string (e.g. "localhost.localstack.cloud:4566").
+func EnsureProfile(ctx context.Context, sink output.Sink, interactive bool, resolvedHost string) error {
+	status, err := needsProfileSetup(resolvedHost)
 	if err != nil {
 		output.EmitWarning(sink, fmt.Sprintf("could not check AWS profile: %v", err))
 		return nil
@@ -203,21 +233,52 @@ func Setup(ctx context.Context, sink output.Sink, interactive bool, resolvedHost
 		return nil
 	}
 
-	if !interactive {
-		output.EmitNote(sink, fmt.Sprintf("No complete LocalStack AWS profile found. Run lstk interactively to configure one, or add a [profile %s] section to ~/.aws/config manually.", profileName))
+	configOK, credsOK, err := profilePresence()
+	if err != nil {
+		output.EmitWarning(sink, fmt.Sprintf("could not check AWS profile presence: %v", err))
+		return nil
+	}
+	if interactive && !configOK && !credsOK {
+		return Setup(ctx, sink, resolvedHost)
+	}
+
+	emitMissingProfileNote(sink)
+	return nil
+}
+
+// Setup checks for the localstack AWS profile and prompts to create or update it if needed.
+// resolvedHost must be a host:port string (e.g. "localhost.localstack.cloud:4566").
+func Setup(ctx context.Context, sink output.Sink, resolvedHost string) error {
+	status, err := needsProfileSetup(resolvedHost)
+	if err != nil {
+		output.EmitWarning(sink, fmt.Sprintf("could not check AWS profile: %v", err))
+		return nil
+	}
+	if !status.anyNeeded() {
+		output.EmitNote(sink, "LocalStack AWS profile is already configured.")
+		return nil
+	}
+
+	configPath, credsPath, err := awsPaths()
+	if err != nil {
+		output.EmitWarning(sink, fmt.Sprintf("could not determine AWS config paths: %v", err))
 		return nil
 	}
 
 	responseCh := make(chan output.InputResponse, 1)
 	output.EmitUserInputRequest(sink, output.UserInputRequestEvent{
-		Prompt:     "Configure AWS profile in ~/.aws/?",
+		Prompt:     "Set up a LocalStack profile for AWS CLI and SDKs in ~/.aws?",
 		Options:    []output.InputOption{{Key: "y", Label: "Y"}, {Key: "n", Label: "n"}},
 		ResponseCh: responseCh,
 	})
 
 	select {
 	case resp := <-responseCh:
-		if resp.Cancelled || resp.SelectedKey == "n" {
+		if resp.Cancelled {
+			return nil
+		}
+		if resp.SelectedKey == "n" {
+			output.EmitNote(sink, "Skipped adding LocalStack AWS profile.")
 			return nil
 		}
 		if status.configNeeded {
@@ -232,12 +293,10 @@ func Setup(ctx context.Context, sink output.Sink, interactive bool, resolvedHost
 				return nil
 			}
 		}
-		output.EmitSuccess(sink, "AWS profile successfully configured")
-		output.EmitNote(sink, fmt.Sprintf("Try: aws s3 mb s3://test --profile %s", profileName))
+		output.EmitSuccess(sink, "Created LocalStack profile in ~/.aws/config")
 	case <-ctx.Done():
 		return ctx.Err()
 	}
 
 	return nil
 }
-

internal/config/containers.go

@@ -138,3 +138,14 @@ func (c *ContainerConfig) ProductName() (string, error) {
 	}
 	return productName, nil
 }
+
+// GetAWSContainer returns the AWS container config from the list of containers.
+// Returns nil if no AWS container is configured.
+func GetAWSContainer(containers []ContainerConfig) *ContainerConfig {
+	for i := range containers {
+		if containers[i].Type == EmulatorAWS {
+			return &containers[i]
+		}
+	}
+	return nil
+}

internal/container/start.go

@@ -184,7 +184,7 @@ func Start(ctx context.Context, rt runtime.Runtime, sink output.Sink, opts Start
 	// Maps emulator types to their post-start setup functions.
 	// Add an entry here to run setup for a new emulator type (e.g. Azure, Snowflake).
 	setups := map[config.EmulatorType]postStartSetupFunc{
-		config.EmulatorAWS: awsconfig.Setup,
+		config.EmulatorAWS: awsconfig.EnsureProfile,
 	}
 	return runPostStartSetups(ctx, sink, opts.Containers, interactive, opts.LocalStackHost, opts.WebAppURL, setups)
 }

internal/ui/app.go

@@ -96,10 +96,10 @@ func (a App) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
 		}
 		if a.pendingInput != nil {
 			if opt := resolveOption(a.pendingInput.Options, msg); opt != nil {
-				a.lines = appendLine(a.lines, styledLine{text: formatResolvedInput(*a.pendingInput, opt.Key)})
 				responseCmd := sendInputResponseCmd(a.pendingInput.ResponseCh, output.InputResponse{SelectedKey: opt.Key})
 				a.pendingInput = nil
-				a.inputPrompt = a.inputPrompt.Hide()
+				a.inputPrompt = components.NewInputPrompt()
+				a.spinner = a.spinner.SetText("")
 				return a, responseCmd
 			}
 		}
@@ -296,24 +296,13 @@ func (a *App) flushBufferedLines() {
 }
 
 func formatResolvedInput(req output.UserInputRequestEvent, selectedKey string) string {
-	formatted := output.FormatPrompt(req.Prompt, req.Options)
-	firstLine := strings.Split(formatted, "\n")[0]
-
 	selected := selectedKey
-	hasLabels := false
 	for _, opt := range req.Options {
-		if opt.Label != "" {
-			hasLabels = true
-		}
 		if opt.Key == selectedKey && opt.Label != "" {
 			selected = opt.Label
 		}
 	}
-
-	if selected == "" || !hasLabels || selectedKey == "any" {
-		return firstLine
-	}
-	return fmt.Sprintf("%s %s", firstLine, selected)
+	return selected
 }
 
 // resolveOption finds the best matching option for a key event, in priority order:

internal/ui/components/input_prompt_test.go

@@ -38,12 +38,12 @@ func TestInputPromptView(t *testing.T) {
 		},
 		{
 			name:   "multiple options shows brackets",
-			prompt: "Configure AWS profile?",
+			prompt: "Set up a LocalStack profile for AWS CLI and SDKs in ~/.aws?",
 			options: []output.InputOption{
 				{Key: "y", Label: "Y"},
 				{Key: "n", Label: "n"},
 			},
-			contains: []string{"?", "Configure AWS profile?", "[Y/n]"},
+			contains: []string{"?", "Set up a LocalStack profile for AWS CLI and SDKs in ~/.aws?", "[Y/n]"},
 		},
 		{
 			name:   "multi-line prompt renders trailing lines",

internal/ui/run_awsconfig.go

@@ -0,0 +1,62 @@
+package ui
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"os"
+
+	tea "github.com/charmbracelet/bubbletea"
+	"github.com/localstack/lstk/internal/awsconfig"
+	"github.com/localstack/lstk/internal/config"
+	"github.com/localstack/lstk/internal/endpoint"
+	"github.com/localstack/lstk/internal/output"
+)
+
+// RunConfigProfile runs the AWS profile setup flow with TUI output.
+// It resolves the host from the AWS container config and runs the setup.
+func RunConfigProfile(parentCtx context.Context, containers []config.ContainerConfig, localStackHost string) error {
+	awsContainer := config.GetAWSContainer(containers)
+	if awsContainer == nil {
+		return fmt.Errorf("no aws emulator configured")
+	}
+
+	resolvedHost, dnsOK := endpoint.ResolveHost(awsContainer.Port, localStackHost)
+	if !dnsOK {
+		output.EmitNote(output.NewTUISink(programSender{}), `Could not resolve "localhost.localstack.cloud" - your system may have DNS rebind protection enabled. Using 127.0.0.1 as the endpoint.`)
+	}
+
+	ctx, cancel := context.WithCancel(parentCtx)
+	defer cancel()
+
+	app := NewApp("", "", "", cancel, withoutHeader())
+	p := tea.NewProgram(app, tea.WithInput(os.Stdin), tea.WithOutput(os.Stdout))
+	runErrCh := make(chan error, 1)
+
+	go func() {
+		err := awsconfig.Setup(ctx, output.NewTUISink(programSender{p: p}), resolvedHost)
+		runErrCh <- err
+		if err != nil && !errors.Is(err, context.Canceled) {
+			p.Send(runErrMsg{err: err})
+			return
+		}
+		p.Send(runDoneMsg{})
+	}()
+
+	model, err := p.Run()
+	if err != nil {
+		return err
+	}
+
+	if app, ok := model.(App); ok && app.Err() != nil {
+		return output.NewSilentError(app.Err())
+	}
+
+	runErr := <-runErrCh
+	if runErr != nil && !errors.Is(runErr, context.Canceled) {
+		return runErr
+	}
+
+	return nil
+}
+