Skip to content

Clarify TUI availability in README #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gtsiolis merged 1 commit into from
Mar 19, 2026
Merged

Clarify TUI availability in README #142

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Running `lstk` will automatically handle configuration setup and start LocalStac
## Features

- **Start / stop / status** — manage LocalStack emulators with a single command
- **Interactive TUI** — a Bubble Tea-powered terminal UI when run in an interactive shell
- **Interactive TUI** — a Bubble Tea-powered terminal UI shown in an interactive terminal for commands like `start`, `login`, `status`, etc.
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Mar 19, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Search for Bubble Tea TUI usage across command implementations

# Search for bubble tea program initialization or TUI-related code
rg -n -C3 --type=go 'tea\.NewProgram|bubbletea|Program\.Run' 

# Search for command definitions and their relationship to TUI
rg -n -C3 --type=go 'cobra\.Command.*Name.*"(start|stop|login|logout|status|logs|update|config)"'

Repository: localstack/lstk

Length of output: 7468

🏁 Script executed:

#!/bin/bash
# Find all command definitions in the codebase
find . -name "*.go" -path "*/cmd/*" -type f | head -20

Repository: localstack/lstk

Length of output: 296

🏁 Script executed:

#!/bin/bash
# List all files in internal/ui/ to identify all TUI command handlers
ls -la internal/ui/run*.go | grep -o 'run[^/]*\.go'

Repository: localstack/lstk

Length of output: 162

🏁 Script executed:

#!/bin/bash
# Search for command registration to find the complete command list
rg -n -A5 'AddCommand|Cmd.*Name' cmd/ --type go | head -50

Repository: localstack/lstk

Length of output: 580

The TUI command list in the README is incomplete; "etc." masks missing commands.

Line 49 lists only start, login, and status as TUI commands, but the codebase implements TUI for seven commands total: start, stop, login, logout, status, logs, and update. Either list all seven commands, or use more general language such as "for action-oriented commands" to avoid misleading readers about which commands provide the interactive TUI.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 49, Update the README TUI description that currently
mentions only `start`, `login`, and `status`: change that line to explicitly
list all implemented TUI commands (`start`, `stop`, `login`, `logout`, `status`,
`logs`, and `update`) or replace "start, login, status, etc." with a clearer
phrase such as "for action-oriented commands such as start, stop, login, logout,
status, logs, and update" so the README accurately reflects the available TUI
commands.

Copy link
Copy Markdown
Member

@silv-io silv-io Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the rabbit is correct, but we also have etc. there so it's a wash

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@silv-io Fair point — the etc. does serve as a catch-all, so readers won't be misled into thinking only those three commands have TUI support. Happy to let this one go! 🐇

(ᵔᴥᵔ)

Copy link
Copy Markdown
Member Author

@gtsiolis gtsiolis Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rabbit does not take into account the intent here is not to list all commands here that support TUI, to avoid maintaing multiple sources of truth. 😁

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

- **Plain output** for CI/CD and scripting (auto-detected in non-interactive environments or forced with `--non-interactive`)
- **Log streaming** — tail emulator logs in real-time with `--follow`; use `--verbose` to show all logs without filtering
- **Browser-based login** — authenticate via browser and store credentials securely in the system keyring
Expand Down Expand Up @@ -151,7 +151,7 @@ lstk --non-interactive
## Usage

```bash
# Start the LocalStack emulator (interactive TUI in a terminal)
# Start the LocalStack emulator
lstk

# Start non-interactively (e.g. in CI)
Expand Down
Loading