Skip to content

lerim up / down / logs

Docker container lifecycle commands for starting, stopping, and monitoring Lerim.

Overview

These host-only commands manage the Docker container that runs lerim serve (daemon + JSON API).

Host-only commands

These commands run on the host machine. They do not require a running Lerim server.

Syntax

lerim up [--build]
lerim down
lerim logs [--follow]

Commands

lerim up

Start Lerim as a Docker service:

lerim up                    # start Lerim (pull GHCR image)
lerim up --build            # build from local Dockerfile instead

This reads ~/.lerim/config.toml, generates a docker-compose.yml in ~/.lerim/, and runs docker compose up -d.

By default the compose file references the pre-built GHCR image (ghcr.io/lerim-dev/lerim-cli) tagged with the current package version. Use --build to build from the local Dockerfile instead (useful for development).

Running lerim up again recreates the container.

lerim down

Stop the Docker container:

lerim down

lerim logs

View container logs:

lerim logs                  # show recent logs
lerim logs --follow         # tail logs continuously

Parameters

--build boolean default: off

Build from local Dockerfile instead of pulling the GHCR image.

--follow boolean default: off

Continuously tail logs (for lerim logs).

Examples

# Start the service
lerim up

# Check it's running
lerim status

# View logs
lerim logs --follow

# Stop when done
lerim down

Notes

  • The container runs lerim serve which provides the daemon loop and JSON API (web UI: Lerim Cloud)
  • Dashboard is available at http://localhost:8765 when running
  • Docker restart policy is "no" — the container does not auto-restart after reboots