Skip to content

DOCS: move lstk setup instructions into the CLI #937

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
joe4dev wants to merge 4 commits into
base: main
Choose a base branch
from
Open

DOCS: move lstk setup instructions into the CLI #937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
035b8a0
Update lstk shell completions to match the CLI
joe4dev Sep 10, 2026
3b113f4
Point at lstk completion instead of duplicating the instructions
joe4dev Sep 11, 2026
6d9229e
Point the completion command entry at lstk completion
joe4dev Sep 11, 2026
ef5a822
Repeat the completion pointer under the Azure section header
joe4dev Sep 11, 2026
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
53 changes: 1 addition & 52 deletions src/content/docs/aws/developer-tools/running-localstack/lstk/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,57 +131,6 @@ These apply to both interactive and non-interactive (scripted/CI) use, see [Auto
`lstk` includes completion scripts for bash, zsh, fish, and powershell.
If you installed via Homebrew, completions are set up automatically.

For manual setup:

<Tabs>
<TabItem label="Bash">

```bash
# Load in current session
eval "$(lstk completion bash)"

# Persist (Linux)
lstk completion bash > /etc/bash_completion.d/lstk

# Persist (macOS with Homebrew)
lstk completion bash > $(brew --prefix)/etc/bash_completion.d/lstk
```

:::note
Use `eval "$(lstk completion bash)"` rather than `source <(lstk completion bash)`.
The `lstk` script works with or without the `bash-completion` package (it bundles a fallback for stock macOS bash 3.2), but `source <(...)` is a silent no-op on that shell.
:::

</TabItem>
<TabItem label="Zsh">

```bash
# Load in current session
source <(lstk completion zsh)

# Persist (Linux)
lstk completion zsh > "${fpath[1]}/_lstk"

# Persist (macOS with Homebrew)
lstk completion zsh > $(brew --prefix)/share/zsh/site-functions/_lstk
```

</TabItem>
<TabItem label="Fish">

```bash
# Load in current session
lstk completion fish | source

# Persist
lstk completion fish > ~/.config/fish/completions/lstk.fish
```

</TabItem>
</Tabs>

Restart your shell after persisting completions.

### `completion`

Generate shell completion scripts.
Expand All @@ -190,4 +139,4 @@ Generate shell completion scripts.
lstk completion [bash|zsh|fish|powershell]
```

See [Shell completions](#shell-completions) above for setup instructions.
Run `lstk completion` to print setup instructions in your terminal.
54 changes: 2 additions & 52 deletions src/content/docs/azure/developer-tools/lstk.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1215,7 +1215,7 @@ Generate shell completion scripts.
lstk completion [bash|zsh|fish|powershell]
```

See [Shell completions](#shell-completions) for setup instructions.
Run `lstk completion` to print setup instructions in your terminal.

## Global options

Expand Down Expand Up @@ -1438,58 +1438,8 @@ Pair this behavior with a custom [`image`](#custom-container-image) that points

`lstk` includes completion scripts for bash, zsh, fish, and powershell.
If you installed via Homebrew, completions are set up automatically.
Once completion is enabled, `lstk aws <TAB>` also completes AWS services, operations, and parameters using the AWS CLI's own completer.

For manual setup:

<Tabs>
<TabItem label="Bash">

```bash
# Load in current session
eval "$(lstk completion bash)"

# Persist (Linux)
lstk completion bash > /etc/bash_completion.d/lstk

# Persist (macOS with Homebrew)
lstk completion bash > $(brew --prefix)/etc/bash_completion.d/lstk
```

:::note
Use `eval "$(lstk completion bash)"` rather than `source <(lstk completion bash)`.
The `lstk` script works with or without the `bash-completion` package (it bundles a fallback for stock macOS bash 3.2), but `source <(...)` is a silent no-op on that shell.
:::

</TabItem>
<TabItem label="Zsh">

```bash
# Load in current session
source <(lstk completion zsh)

# Persist (Linux)
lstk completion zsh > "${fpath[1]}/_lstk"

# Persist (macOS with Homebrew)
lstk completion zsh > $(brew --prefix)/share/zsh/site-functions/_lstk
```

</TabItem>
<TabItem label="Fish">

```bash
# Load in current session
lstk completion fish | source

# Persist
lstk completion fish > ~/.config/fish/completions/lstk.fish
```

</TabItem>
</Tabs>

Restart your shell after persisting completions.
Run `lstk completion` to print setup instructions in your terminal.

## FAQ

Expand Down
Loading