Skip to content
Open
Changes from all commits
Commits
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
104 changes: 102 additions & 2 deletions src/content/docs/aws/tooling/localstack-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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.

Expand Down Expand Up @@ -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.

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)

### 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

Choose a reason for hiding this comment

The 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?

  • user can modify config file and the file itself includes guidance
  • if a lstk.toml (or however we decide this to be) is included in local dir, lstk will automatically use this profile
  • (if we don't plan to fix the "default to pull latest" issue right now) global config defaults to pulling latest

Copy link
Member

Choose a reason for hiding this comment

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

We decided on .lstk/config.toml for the local config file.

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?

Choose a reason for hiding this comment

The 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
```