README
¶
lstk
A command-line interface for LocalStack. Built in Go with a modern terminal UI and native CLI experience for managing and interacting with LocalStack deployments. 👾
npm install -g @localstack/lstk
See Installation for other install methods.
Prerequisites
- Docker — required as a container engine.
- LocalStack account — required for credentials, the CLI will guide you through authentication.
Installation
Homebrew (macOS / Linux)
brew install localstack/tap/lstk
npm
npm install -g @localstack/lstk
Binaries
Pre-built binaries are also available from GitHub Releases. 📦
Quick Start
lstk
Running lstk will automatically handle authentication, configuration, and container setup, then start LocalStack. On the first interactive run, it also prompts you to pick which emulator to run (AWS, Azure, or Snowflake) and remembers your choice.
Features
- Start / stop / status / logs — manage the full LocalStack emulator lifecycle with a single command
- Interactive TUI — a Bubble Tea-powered terminal UI in interactive terminals, plain output for CI/CD and scripting
- Browser-based login — authenticate via browser and store credentials securely in the system keyring, or use
LOCALSTACK_AUTH_TOKENfor CI - Snapshots — save, load, and manage emulator state as local files, cloud snapshots, or in your own S3 bucket
- Cloud CLI proxies — run
aws,az,terraform,cdk, andsamcommands against LocalStack with the endpoint, credentials, and region pre-configured - Extensions — Git-style
lstk-<name>executables extend the CLI with new commands; see docs/extensions-authoring.md - Self-update —
lstk updatechecks for and installs the latest release - Structured JSON output — pass
--jsonto a supported command for a machine-readable envelope instead of formatted text; see docs/structured-output.md
For the full command reference, configuration options, environment variables, and troubleshooting, see the lstk documentation.
Contributing
See CONTRIBUTING.md for development setup, architecture, and pull request guidelines.
Reporting bugs
Feedback is welcome! Use the repository issue tracker for bug reports or feature requests.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
auth
Package auth is a generated GoMock package.
|
Package auth is a generated GoMock package. |
|
extension
Package extension implements lstk's Git-style extension mechanism: when a user runs `lstk <name>` and `<name>` is not a built-in command, lstk resolves and executes an external `lstk-<name>` executable, forwarding arguments, streams, and the exit code.
|
Package extension implements lstk's Git-style extension mechanism: when a user runs `lstk <name>` and `<name>` is not a built-in command, lstk resolves and executes an external `lstk-<name>` executable, forwarding arguments, streams, and the exit code. |
|
output
Package output defines events for the event/sink system
|
Package output defines events for the event/sink system |
|
proc
Package proc runs wrapped external tools (aws, terraform, cdk, sam, az, and extensions) so that termination signals reach the child gracefully instead of hard-killing it.
|
Package proc runs wrapped external tools (aws, terraform, cdk, sam, az, and extensions) so that termination signals reach the child gracefully instead of hard-killing it. |
|
runtime
Package runtime is a generated GoMock package.
|
Package runtime is a generated GoMock package. |
|
tracing
Tracing is disabled by default; set LSTK_OTEL=1 to enable it.
|
Tracing is disabled by default; set LSTK_OTEL=1 to enable it. |
|
validate
Package validate provides reusable, deterministic validators for user-supplied CLI inputs.
|
Package validate provides reusable, deterministic validators for user-supplied CLI inputs. |
|
test
|
|
|
integration
module
|