-
Notifications
You must be signed in to change notification settings - Fork 30
docs: add Phase 1 preview for new Go-based CLI (lstk) #504
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,11 +14,14 @@ It provides convenience features to interact with LocalStack features like Cloud | |
|
|
||
| To install the LocalStack CLI, follow the [installation guide](/aws/getting-started/installation/#installing-localstack-cli). | ||
|
|
||
|
|
||
| ## LocalStack CLI | ||
|
|
||
| :::note | ||
| This documentation was auto-generated from LocalStack CLI version `LocalStack CLI 4.14.0`. | ||
| ::: | ||
|
|
||
| ## Global Options | ||
| ### Global Options | ||
|
|
||
| The following global options are available for the `localstack` CLI: | ||
|
|
||
|
|
@@ -29,7 +32,7 @@ The following global options are available for the `localstack` CLI: | |
| | `-p`, `--profile TEXT` | Set the configuration profile | | ||
| | `-h`, `--help` | Show help message and exit | | ||
|
|
||
| ## Commands | ||
| ### Commands | ||
|
|
||
| The following commands are available for managing your LocalStack instance. | ||
|
|
||
|
|
@@ -1340,3 +1343,100 @@ Options: | |
| ``` | ||
|
|
||
| </details> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## lstk | ||
|
|
||
| :::note | ||
| **lstk**: We are currently rolling out a new, high-performance CLI written in Go. During this initial phase, the new CLI (`lstk`) supports core lifecycle commands (start, stop, logs). For advanced features such as **Cloud Pods**, **Extensions**, and **Ephemeral Instances**, please continue to use the current LocalStack CLI. Both tools can be installed and used on the same machine. | ||
quetzalliwrites marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Advanced features in `lstk` are coming soon. | ||
| ::: | ||
|
|
||
| `lstk` is meant to provide a modern terminal experience with a built-in terminal UI (TUI). It currently includes some interactivity, but it's not a dashboard-style long-running TUI yet. | ||
|
|
||
| To install the new CLI and test it out, follow the [installation steps.](https://github.com/localstack/lstk/blob/main/README.md#installation) | ||
quetzalliwrites marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Global Options | ||
| The following global options are available for the `lstk` CLI: | ||
|
|
||
| | Option | Description | | ||
| | :--- | :--- | | ||
| | --config string | Path to a specific TOML config file | | ||
| | --non-interactive | Disable the interactive TUI and use plain text output | | ||
| | -v, --version | Show the version and exit | | ||
| | -h, --help | Show help message and exit | | ||
|
|
||
| ### Commands | ||
| The new CLI uses a flat command structure. Advanced subcommands aren't available in this initial release. | ||
|
|
||
| #### lstk | ||
| Start LocalStack interactively. | ||
|
|
||
| Running `lstk` automatically handles authentication, updating, and starting LocalStack automatically. | ||
|
|
||
|
|
||
| #### start | ||
| Start the LocalStack emulator. If run interactively, it launches the Terminal UI. | ||
|
|
||
| ```bash | ||
| Usage: lstk start [OPTIONS] | ||
|
|
||
| # Start in non-interactive mode (CI/CD) | ||
| lstk start --non-interactive | ||
| ``` | ||
|
|
||
| #### stop | ||
| Stop the running LocalStack emulator. | ||
|
|
||
| ```bash | ||
| Usage: lstk stop | ||
| ``` | ||
|
|
||
| #### status | ||
| Show emulator status and a summary of deployed resources. | ||
|
|
||
| ```bash | ||
| Usage: lstk status | ||
| ``` | ||
|
|
||
| #### logs | ||
| Show or stream emulator logs. | ||
|
|
||
| ```bash | ||
| Usage: lstk logs [OPTIONS] | ||
|
|
||
| Options: | ||
| --follow Stream logs in real-time | ||
| --verbose Show all logs without filtering | ||
| ``` | ||
|
|
||
| #### login / logout | ||
| Manage your LocalStack authentication. `login` will open a browser window to authenticate. | ||
|
|
||
| ```bash | ||
| Usage: lstk login | ||
| Usage: lstk logout | ||
| ``` | ||
|
|
||
| #### config | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @silv-io can you provide some basic info re config files for @quetzalliwrites to incorporate here?
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We decided on The readme covers the config quite well: https://github.com/localstack/lstk?tab=readme-ov-file#configuration We can extract something out of there or just link to it? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks @silv-io - that looks good and clear. @quetzalliwrites can you incorporate this updated config info into the docs please? |
||
| Manage the CLI configuration. Use `path` to find your active configuration file. | ||
|
|
||
| ```bash | ||
| Usage: lstk config COMMAND | ||
|
|
||
| Commands: | ||
| path Show the path to the current config.toml | ||
| ``` | ||
|
|
||
| #### update | ||
| Check for or install the latest version of the `lstk` binary. | ||
|
|
||
| ```bash | ||
| Usage: lstk update [OPTIONS] | ||
|
|
||
| Options: | ||
| --check Check for updates without installing | ||
| ``` | ||
Uh oh!
There was an error while loading. Please reload this page.