lstk

command module
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 5, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

README

lstk

lstk is a command-line interface for LocalStack built in Go with a modern terminal UI, and native CLI experience for managing and interacting LocalStack deployments. 👾

Features

  • Start / stop LocalStack emulators with a single command
  • Interactive TUI — a Bubble Tea-powered terminal UI when run in an interactive shell
  • Plain output for CI/CD and scripting (auto-detected in non-interactive environments)
  • Log streaming — tail emulator logs in real-time with --follow
  • Browser-based login — authenticate via browser and store credentials securely in the system keyring
  • Shell completions — bash, zsh, and fish completions included

Installation

Homebrew (macOS / Linux)
brew install localstack/tap/lstk
NPM
npm install -g @localstack/lstk
lstk start
Manual (binary download)

Download the latest release for your platform from the GitHub Releases page. Binaries are available for:

  • linux/amd64, linux/arm64
  • darwin/amd64, darwin/arm64 (macOS)
  • windows/amd64, windows/arm64

Requirements

Usage

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

# Start non-interactively (e.g. in CI)
LOCALSTACK_AUTH_TOKEN=<token> lstk start

# Stop the running emulator
lstk stop

# Stream emulator logs
lstk logs --follow

# Log in (opens browser for authentication)
lstk login

# Log out (removes stored credentials)
lstk logout

# Show resolved config file path
lstk config path

# Show version info
lstk version

Authentication

lstk resolves your auth token in this order:

  1. System keyring — a token stored by a previous lstk login
  2. LOCALSTACK_AUTH_TOKEN environment variable
  3. Browser login — triggered automatically in interactive mode when neither of the above is present

Note: If a keyring token exists, it takes precedence over LOCALSTACK_AUTH_TOKEN. Setting or changing the environment variable will have no effect until the keyring token is removed. Run lstk logout to clear the stored keyring token, after which the env var will be used.

Configuration

lstk uses a TOML config file, created automatically on first run.

Config lookup order:

  1. ./lstk.toml (project-local)
  2. $HOME/.config/lstk/config.toml
  3. os.UserConfigDir()/lstk/config.toml

To see which config file is currently in use:

lstk config path

Versioning

lstk uses ZeroVer (0.MINOR.PATCH). The project is in active development and has not reached a stable 1.0 release.

Reporting bugs

Feedback is welcome! Use the repository issue tracker for bug reports or feature requests.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
api
auth
Package auth is a generated GoMock package.
Package auth is a generated GoMock package.
env
output
Package output defines events for the event/sink system
Package output defines events for the event/sink system
runtime
Package runtime is a generated GoMock package.
Package runtime is a generated GoMock package.
ui
test
integration module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL