Skip to content

revamp the lstk docs #531

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

Open
HarshCasper wants to merge 1 commit into
base: main
Choose a base branch
from
+607 −128
Open

revamp the lstk docs #531

Show file tree
Hide file tree
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: 4 additions & 0 deletions astro.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,10 @@ export default defineConfig({
label: 'LocalStack CLI',
slug: 'aws/tooling/localstack-cli',
},
{
label: 'lstk',
slug: 'aws/tooling/lstk',
},
{
label: 'LocalStack SDKs',
autogenerate: {
Expand Down
131 changes: 3 additions & 128 deletions src/content/docs/aws/tooling/localstack-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@ 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).

:::note
**lstk**: We are currently rolling out `lstk`; a new, high-performance CLI. Check it out [here](https://docs.localstack.cloud/aws/tooling/localstack-cli/#lstk).
:::
**lstk**: We are currently rolling out `lstk`, a new, high-performance CLI built in Go.
Check it out [here](/aws/tooling/lstk/).
:::

## LocalStack CLI

Expand Down Expand Up @@ -1344,129 +1345,3 @@ 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)

### Configuration

`lstk` uses a TOML config file, created automatically on first run. The file itself includes guidance for manual modifications.

**Search Order**
`lstk` uses the first configuration file found in this priority:

1. **Local**: `./.lstk/config.toml` (automatically used as the active profile)
2. **User**: `$HOME/.config/lstk/config.toml`
3. **OS Default**:
* **macOS**: `$HOME/Library/Application Support/lstk/config.toml`
* **Windows**: `%AppData%\lstk\config.toml`

:::note
On first run, the config is created at path #2 if `$HOME/.config/` exists; otherwise, it uses path #3. By default, the global config is set to pull the latest updates.
:::

### Commands
**See active config path:**
```bash
lstk config path
```

**Manual override:**
```bash
lstk --config /path/to/config.toml start
```


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