Skip to content

Commit cc139e0

Browse files
authored
revamp the lstk docs (#531)
1 parent 0eab402 commit cc139e0

3 files changed

Lines changed: 607 additions & 128 deletions

File tree

astro.config.mjs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,6 +330,10 @@ export default defineConfig({
330330
label: 'LocalStack CLI',
331331
slug: 'aws/tooling/localstack-cli',
332332
},
333+
{
334+
label: 'lstk',
335+
slug: 'aws/tooling/lstk',
336+
},
333337
{
334338
label: 'LocalStack SDKs',
335339
autogenerate: {

src/content/docs/aws/tooling/localstack-cli.md

Lines changed: 3 additions & 128 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ It provides convenience features to interact with LocalStack features like Cloud
1515
To install the LocalStack CLI, follow the [installation guide](/aws/getting-started/installation/#installing-localstack-cli).
1616

1717
:::note
18-
**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).
19-
:::
18+
**lstk**: We are currently rolling out `lstk`, a new, high-performance CLI built in Go.
19+
Check it out [here](/aws/tooling/lstk/).
20+
:::
2021

2122
## LocalStack CLI
2223

@@ -1344,129 +1345,3 @@ Options:
13441345
```
13451346
13461347
</details>
1347-
1348-
1349-
1350-
1351-
## lstk
1352-
1353-
:::note
1354-
**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.
1355-
1356-
Advanced features in `lstk` are coming soon.
1357-
:::
1358-
1359-
`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.
1360-
1361-
To install the new CLI and test it out, follow the [installation steps.](https://github.com/localstack/lstk/blob/main/README.md#installation)
1362-
1363-
### Configuration
1364-
1365-
`lstk` uses a TOML config file, created automatically on first run. The file itself includes guidance for manual modifications.
1366-
1367-
**Search Order**
1368-
`lstk` uses the first configuration file found in this priority:
1369-
1370-
1. **Local**: `./.lstk/config.toml` (automatically used as the active profile)
1371-
2. **User**: `$HOME/.config/lstk/config.toml`
1372-
3. **OS Default**:
1373-
* **macOS**: `$HOME/Library/Application Support/lstk/config.toml`
1374-
* **Windows**: `%AppData%\lstk\config.toml`
1375-
1376-
:::note
1377-
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.
1378-
:::
1379-
1380-
### Commands
1381-
**See active config path:**
1382-
```bash
1383-
lstk config path
1384-
```
1385-
1386-
**Manual override:**
1387-
```bash
1388-
lstk --config /path/to/config.toml start
1389-
```
1390-
1391-
1392-
### Global Options
1393-
The following global options are available for the `lstk` CLI:
1394-
1395-
| Option | Description |
1396-
| :--- | :--- |
1397-
| --config string | Path to a specific TOML config file |
1398-
| --non-interactive | Disable the interactive TUI and use plain text output |
1399-
| -v, --version | Show the version and exit |
1400-
| -h, --help | Show help message and exit |
1401-
1402-
### Commands
1403-
The new CLI uses a flat command structure. Advanced subcommands aren't available in this initial release.
1404-
1405-
#### lstk
1406-
Start LocalStack interactively.
1407-
1408-
Running `lstk` automatically handles authentication, updating, and starting LocalStack automatically.
1409-
1410-
1411-
#### start
1412-
Start the LocalStack emulator. If run interactively, it launches the Terminal UI.
1413-
1414-
```bash
1415-
Usage: lstk start [OPTIONS]
1416-
1417-
# Start in non-interactive mode (CI/CD)
1418-
lstk start --non-interactive
1419-
```
1420-
1421-
#### stop
1422-
Stop the running LocalStack emulator.
1423-
1424-
```bash
1425-
Usage: lstk stop
1426-
```
1427-
1428-
#### status
1429-
Show emulator status and a summary of deployed resources.
1430-
1431-
```bash
1432-
Usage: lstk status
1433-
```
1434-
1435-
#### logs
1436-
Show or stream emulator logs.
1437-
1438-
```bash
1439-
Usage: lstk logs [OPTIONS]
1440-
1441-
Options:
1442-
--follow Stream logs in real-time
1443-
--verbose Show all logs without filtering
1444-
```
1445-
1446-
#### login / logout
1447-
Manage your LocalStack authentication. `login` will open a browser window to authenticate.
1448-
1449-
```bash
1450-
Usage: lstk login
1451-
Usage: lstk logout
1452-
```
1453-
1454-
#### config
1455-
Manage the CLI configuration. Use `path` to find your active configuration file.
1456-
1457-
```bash
1458-
Usage: lstk config COMMAND
1459-
1460-
Commands:
1461-
path Show the path to the current config.toml
1462-
```
1463-
1464-
#### update
1465-
Check for or install the latest version of the `lstk` binary.
1466-
1467-
```bash
1468-
Usage: lstk update [OPTIONS]
1469-
1470-
Options:
1471-
--check Check for updates without installing
1472-
```

0 commit comments

Comments
 (0)