CLI
lawn catalog
Browse, search, and install apps from the Lawn catalog.
| Command | Description |
|---|---|
lawn catalog list | List available app templates |
lawn catalog search <query> | Search templates by name, description, or tags |
lawn catalog info <id> | Show details for a template |
lawn catalog install <id> | Install an app from the catalog |
lawn catalog refresh | Pull the latest catalog updates |
lawn catalog repos | List configured catalog sources |
lawn catalog list
List all available app templates.
lawn catalog list
Aliases: ls
| Option | Description |
|---|---|
--category <name> | Filter by category |
-q, --quiet | Only display template IDs |
# Filter by category
lawn catalog list --category Media
# Get just the IDs (useful for scripting)
lawn catalog list --quiet
lawn catalog search
Search available app templates by name, description, or tags.
lawn catalog search <query>
| Option | Description |
|---|---|
-q, --quiet | Only display template IDs |
lawn catalog search photos
lawn catalog search "password manager"
lawn catalog info
Show full details for an app template, including its description, features, and links.
lawn catalog info <template-id>
lawn catalog info jellyfin
lawn catalog info paperless-ngx
lawn catalog install
Install an app from the catalog. This pulls the container image, creates an instance, and starts it.
lawn catalog install <template-id>
| Option | Description |
|---|---|
--name <name> | Custom name for the instance |
-p, --port <mapping> | Port override as containerPort:hostPort (repeatable) |
--random-port | Use randomly assigned free ports |
--var <assignment> | Variable value as NAME=VALUE (repeatable) |
--no-start | Create the instance without starting it |
# Basic install
lawn catalog install vaultwarden
# Custom name and port
lawn catalog install jellyfin --name "Media Server" --port 8096:9000
# Supply required variables non-interactively
lawn catalog install paperless-ngx --var ADMIN_PASSWORD=mypassword
# Install without starting
lawn catalog install nextcloud --no-start
If an app requires user-provided variables (like an admin password), the CLI prompts you interactively. Use --var to skip the prompts.
lawn catalog refresh
Pull the latest catalog updates from all configured repositories.
lawn catalog refresh
Lawn automatically updates the catalog in the background, but you can use this command to force an immediate update.
lawn catalog repos
List configured catalog repository sources.
lawn catalog repos
Shows the URL, git ref, and path for each catalog source.
Continue reading