CLI
lawn app
Manage installed app instances — lifecycle, logs, configuration, and more.
All lawn app commands accept an instance name or ID to identify which app to act on.
| Command | Description |
|---|---|
lawn app list | List all installed instances |
lawn app info show <instance> | Show instance details |
lawn app ps | Show running containers |
lawn app start <instance> | Start an instance |
lawn app stop <instance> | Stop an instance |
lawn app restart <instance> | Restart an instance |
lawn app remove <instance> | Remove an instance |
lawn app logs <instance> | View container logs |
lawn app exec <instance> -- <cmd> | Run a command in a container |
lawn app shell <instance> | Open an interactive shell |
lawn app ports | View and manage port configuration |
lawn app env | View and manage environment variables |
lawn app resources | View and manage resource limits |
lawn app info notices | View and manage notices |
lawn app list
List all installed app instances.
lawn app list
Aliases: ls
| Option | Description |
|---|---|
-q, --quiet | Only display instance IDs |
lawn app info show
Show detailed information about an app instance.
lawn app info show <instance>
lawn app ps
Show running containers across all instances.
lawn app ps
| Option | Description |
|---|---|
-q, --quiet | Only display instance/container identifiers |
-a, --all | Show all containers, including stopped |
lawn app start
Start an app instance and all its containers.
lawn app start <instance>
lawn app stop
Gracefully stop an app instance.
lawn app stop <instance>
lawn app restart
Stop and start an app instance.
lawn app restart <instance>
lawn app remove
Remove an installed app instance.
lawn app remove <instance>
Aliases: rm
| Option | Description |
|---|---|
--force | Skip the confirmation prompt |
--keep-data | Preserve instance data (volumes) |
# Remove and delete all data
lawn app remove jellyfin
# Remove but keep data for later reinstall
lawn app remove jellyfin --keep-data
# Skip confirmation
lawn app remove jellyfin --force
lawn app logs
View logs from an app instance.
lawn app logs <instance>
| Option | Description |
|---|---|
-f, --follow | Stream logs in real time |
-n, --tail <lines> | Number of lines to show from the end |
--container <name> | Filter to a specific container |
# Follow logs in real time
lawn app logs jellyfin --follow
# Show last 50 lines
lawn app logs jellyfin --tail 50
# Logs from a specific container
lawn app logs nextcloud --container db
lawn app exec
Execute a command inside a running container.
lawn app exec <instance> -- <command>
| Option | Description |
|---|---|
-i, --interactive | Keep stdin open |
-t | Allocate a pseudo-TTY |
--container <name> | Target a specific container |
# Run a one-off command
lawn app exec nextcloud -- ls /var/www/html
# Interactive session
lawn app exec -it nextcloud -- /bin/bash
lawn app shell
Open an interactive shell inside a running container. The shell is auto-detected (bash, sh, etc.).
lawn app shell <instance>
| Option | Description |
|---|---|
--container <name> | Target a specific container |
--shell <path> | Shell to use (auto-detected if omitted) |
lawn app ports
View and manage port configuration.
# List ports
lawn app ports list <instance>
# Set a port override
lawn app ports set <instance> <containerPort>:<hostPort>
# Reset to template defaults
lawn app ports reset <instance> [containerPort]
The set and reset commands accept -r, --restart to automatically restart the instance.
lawn app env
View and manage environment variables.
# List environment variables
lawn app env list <instance>
# Set an override
lawn app env set <instance> NAME=VALUE
# Reset to template defaults
lawn app env reset <instance> [name]
| Option | Description |
|---|---|
-c, --container <name> | Filter or target a specific container |
-r, --restart | Restart the instance after the change |
lawn app resources
View and manage resource limits.
# List resource limits
lawn app resources list <instance>
# Set memory limit (in MB, minimum 128)
lawn app resources set <instance> <memoryMB>
# Reset to template defaults
lawn app resources reset <instance>
The set and reset commands accept:
| Option | Description |
|---|---|
-c, --container <name> | Target a specific container |
-r, --restart | Restart the instance after the change |
lawn app info notices
View and manage template notices for an instance.
# List notices
lawn app info notices list <instance>
# Dismiss a notice
lawn app info notices dismiss <instance> <noticeId>
# Restore all dismissed notices
lawn app info notices restore <instance>
Continue reading