#simplestlrs CLI reference

Operating model: Local / self-managed

simplestlrs acquires exact LRS releases and operates the Local / self-managed runtime on Linux and macOS.

#pull

simplestlrs pull <version>

• Purpose: Acquire an approved, exact LRS release.
• Prerequisites: Docker running, browser access, curl, and an authorized Simplest Data account.
• Arguments/options: One exact semantic version. latest is unsupported.
• Authorization: Uses browser authorization and license acceptance when required, then receives temporary access to the approved artifact.
• Side effects: Creates simplestdata/lrs:<version> and installs or updates simplestlrs.
• Common failures: Docker unavailable, authorization denied or expired, account unauthorized, release unavailable, distribution service unavailable, or conflicting local image.
• Related guide: Acquire the Developer LRS.

The initial public form is:

curl -fsSL https://registry.simplestdata.com/lrs | sh -s -- pull 1.0.1

#start

simplestlrs start <version> [--bind <IP>] [--port <port>] [--config <path>]

• Purpose: Start an acquired LRS release.
• Prerequisites: Docker with Compose and simplestdata/lrs:<version> available locally.
• Arguments/options: Exact release version; optional bind address, port from 1 through 65535, and YAML configuration path.
• Network behavior: Binds to 127.0.0.1:8000 by default and warns when using a non-loopback address.
• Side effects: Creates local runtime state and creates or reuses persistent PostgreSQL storage.
• Common failures: Release unavailable locally, Docker/Compose unavailable, invalid configuration, port collision, startup/readiness failure, or conflicting active runtime configuration.
• Related guides: Run the LRS, configuration, and networking.

#status

simplestlrs status

• Purpose: Show the configured release and runtime service state.
• Prerequisites: Docker must be reachable.
• Arguments/options: None.
• Network behavior: Local Docker access only.
• Side effects: None.
• Common failures: Docker unavailable or invalid saved runtime state.
• Related guide: Run the LRS.

#logs

simplestlrs logs

• Purpose: print the most recent 200 log lines from the LRS service.
• Prerequisites: Docker reachable and a local runtime previously started.
• Arguments/options: none.
• Network behavior: local Docker access only.
• Side effects: none.
• Common failures: Docker unavailable, no started runtime, or invalid saved runtime state.
• Related guide: Troubleshooting.

#stop

simplestlrs stop

• Purpose: Stop the running LRS.
• Prerequisites: Docker must be reachable.
• Arguments/options: None.
• Network behavior: Local Docker access only.
• Side effects: Removes the runtime containers and preserves PostgreSQL data.
• Common failures: Docker unavailable or invalid saved runtime state. Calling stop when no runtime is active reports that the LRS is already stopped.
• Related guide: Persistence.

#config show

simplestlrs config show [--config <path>]

• Purpose: Show the effective LRS configuration.
• Prerequisites: None.
• Arguments/options: Optional YAML configuration path.
• Network behavior: No authentication or network access.
• Side effects: None.
• Common failures: Explicit file missing, malformed YAML, unsupported fields, invalid bind address or port, or unsupported configuration values.
• Related guide: Configuration.