> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lstack.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI overview

> Operate an installed LStack instance with the bundled lstack command.

The `lstack` CLI is included in every installable artifact. It starts and stops the local core, reports health, manages updates and backups, and gathers diagnostics.

## Common commands

| Command            | Purpose                                                              |
| ------------------ | -------------------------------------------------------------------- |
| `lstack start`     | Start the local core and wait for it to become healthy               |
| `lstack stop`      | Stop the core without deleting durable workers or project runtimes   |
| `lstack restart`   | Stop and start the core                                              |
| `lstack status`    | Report process, health, version, port, and Docker state              |
| `lstack open`      | Open the dashboard in the default browser                            |
| `lstack logs`      | Follow the core log                                                  |
| `lstack doctor`    | Run diagnostic checks                                                |
| `lstack backup`    | Create a verified SQLite backup                                      |
| `lstack update`    | Install an update or roll back to the retained version               |
| `lstack uninstall` | Remove installed program files while preserving user data by default |

## Machine-readable output

Commands that support `--json` return versioned envelopes for automation. Use the exit code and structured payload together rather than parsing human-readable output.

```bash theme={null}
lstack status --json
lstack doctor --json
```

## Find the executable

The installer creates the CLI shim at:

```text theme={null}
~/.lstack/bin/lstack
```

If that directory is not on your `PATH`, the installer prints the command needed to add it.

<Card title="Diagnostics" icon="stethoscope" href="/operations/diagnostics">
  Use status, doctor, logs, and the redacted support bundle to investigate problems.
</Card>