Skip to content

Commit 5fdb225

Browse files
DOC-429: Move Global options table to the Overview page
Mirrors the same fix agreed on the AWS docs sync PR (#912): Global options apply to everyday interactive use, not just automation/CI, so move the table from automation.mdx to index.mdx, right after Quick start, keeping the detailed sections (Structured output) on automation.mdx with an absolute-path cross-reference.
1 parent 066ee12 commit 5fdb225

2 files changed

Lines changed: 22 additions & 20 deletions

File tree

src/content/docs/azure/developer-tools/lstk/automation.mdx

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,10 @@
11
---
22
title: lstk Automation & CI
3-
description: Global options, non-interactive mode, structured JSON output, environment variables, tracing, and logging for scripting lstk.
3+
description: Non-interactive mode, structured JSON output, environment variables, tracing, and logging for scripting lstk.
44
template: doc
55
tags: ['Hobby']
66
---
77

8-
## Global options
9-
10-
These options are available for all commands:
11-
12-
| Option | Description |
13-
|:--------------------|:------------------------------------------------------------------------------|
14-
| `--config <path>` | Path to a specific TOML config file |
15-
| `--non-interactive` | Disable the interactive TUI, use plain output |
16-
| `--json` | Emit a single machine-readable JSON envelope on stdout instead of human-oriented output. Supported by `stop`, `reset`, and `update`; any other command rejects it. See [Structured output](#structured-output). |
17-
| `--persist` | Persist emulator state across restarts (on `start`/bare `lstk` and `restart`) |
18-
| `--type <type>`, `-t <type>` | Emulator type to start: `aws`, `snowflake`, or `azure` (on `start`/bare `lstk`; records the choice in config). See [Selecting the emulator with `--type`](/azure/developer-tools/lstk/lifecycle-commands/#selecting-the-emulator-with---type). |
19-
| `--snapshot <REF>` | Snapshot REF to auto-load after start (on `start`/bare `lstk`; overrides config for one run) |
20-
| `--no-snapshot` | Skip auto-loading the configured snapshot (on `start`/bare `lstk`) |
21-
| `--timeout <duration>` | Startup readiness deadline for `start`/bare `lstk`, as a Go duration; overrides `LSTK_STARTUP_TIMEOUT` for one run. See [`start`](/azure/developer-tools/lstk/lifecycle-commands/#start). |
22-
| `-v`, `--version` | Print the version and exit |
23-
| `-h`, `--help` | Print help and exit |
24-
258
## Interactive and non-interactive mode
269

2710
`lstk` automatically selects its output mode:

src/content/docs/azure/developer-tools/lstk/index.mdx

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ Running `lstk` with no arguments takes you through the entire startup flow autom
2020

2121
This section is split into focused pages:
2222

23-
- **Overview** (this page): installation, quick start, and shell completions.
23+
- **Overview** (this page): installation, quick start, global options, and shell completions.
2424
- [Authentication](/azure/developer-tools/lstk/authentication/): logging in and out, and how `lstk` resolves your auth token.
2525
- [Configuration](/azure/developer-tools/lstk/configuration/): the `config.toml` file, emulator types, environment variables, and volumes.
2626
- [Lifecycle commands](/azure/developer-tools/lstk/lifecycle-commands/): `start`, `stop`, `restart`, `status`, `logs`, `reset`, `volume`.
2727
- [Cloud & IaC commands](/azure/developer-tools/lstk/cloud-and-iac-commands/): `aws`, `az`, `terraform`, `cdk`, `sam`.
2828
- [Snapshots](/azure/developer-tools/lstk/snapshots/): save and load emulator state with `snapshot save`/`load`/`list`/`remove`/`show`.
29-
- [Automation & CI](/azure/developer-tools/lstk/automation/): global options, non-interactive mode, structured output, and environment variables.
29+
- [Automation & CI](/azure/developer-tools/lstk/automation/): non-interactive mode, structured output, and environment variables.
3030
- [Setup & maintenance](/azure/developer-tools/lstk/setup-and-maintenance/): `setup`, `config`, `update`, and offline/enterprise environments.
3131
- [FAQ & Troubleshooting](/azure/developer-tools/lstk/faq-and-troubleshooting/).
3232

@@ -102,6 +102,25 @@ LOCALSTACK_AUTH_TOKEN=<your-ci-auth-token> lstk --non-interactive
102102

103103
CI environments require a CI Auth Token; a personal Developer Auth Token cannot be used there.
104104

105+
## Global options
106+
107+
These options are available for all commands:
108+
109+
| Option | Description |
110+
|:--------------------|:------------------------------------------------------------------------------|
111+
| `--config <path>` | Path to a specific TOML config file |
112+
| `--non-interactive` | Disable the interactive TUI, use plain output |
113+
| `--json` | Emit a single machine-readable JSON envelope on stdout instead of human-oriented output. Supported by `stop`, `reset`, and `update`; any other command rejects it. See [Structured output](/azure/developer-tools/lstk/automation/#structured-output). |
114+
| `--persist` | Persist emulator state across restarts (on `start`/bare `lstk` and `restart`) |
115+
| `--type <type>`, `-t <type>` | Emulator type to start: `aws`, `snowflake`, or `azure` (on `start`/bare `lstk`; records the choice in config). See [Selecting the emulator with `--type`](/azure/developer-tools/lstk/lifecycle-commands/#selecting-the-emulator-with---type). |
116+
| `--snapshot <REF>` | Snapshot REF to auto-load after start (on `start`/bare `lstk`; overrides config for one run) |
117+
| `--no-snapshot` | Skip auto-loading the configured snapshot (on `start`/bare `lstk`) |
118+
| `--timeout <duration>` | Startup readiness deadline for `start`/bare `lstk`, as a Go duration; overrides `LSTK_STARTUP_TIMEOUT` for one run. See [`start`](/azure/developer-tools/lstk/lifecycle-commands/#start). |
119+
| `-v`, `--version` | Print the version and exit |
120+
| `-h`, `--help` | Print help and exit |
121+
122+
These apply to both interactive and non-interactive (scripted/CI) use, see [Automation & CI](/azure/developer-tools/lstk/automation/) for the details behind `--non-interactive` and `--json`.
123+
105124
## Shell completions
106125

107126
`lstk` includes completion scripts for bash, zsh, fish, and powershell.

0 commit comments

Comments
 (0)