DevelopmentUnreleased

This topic is not available in this guide. You're viewing its overview.

Development documentation may include features that are not in the latest release. Read the Lawn 0.8.1 guide.

CLI

lawn system

System-level commands for CLI setup, images, update Snapshot retention, sleep prevention, and registry mirrors.

System commands

CommandDescription
lawn system images listList stored images and their retention status
lawn system images pruneRemove unused images
lawn system cli installCreate a symlink in /usr/local/bin
lawn system cli uninstallRemove the symlink
lawn system config update-snapshots [value]Read or change update Snapshot retention
lawn system config prevent-sleepRead or change idle sleep prevention
lawn system config show-debugging-appsRead or change debugging-app visibility in the catalog
lawn system config mirror listList registry mirrors
lawn system config mirror set <registry> <mirror-url>Set a mirror
lawn system config mirror remove <registry>Remove a mirror
lawn system config experiments listList experimental features

For local network permission, app health results, and port diagnostics, use lawn doctor.

lawn system images list

List stored container images and whether they are still needed.

lawn system images list

lawn system images prune

Remove images and unpacked image versions that no installed app, retained snapshot, or operation needs. Lawn also cleans up unused images automatically.

OptionDescription
--dry-runShow what is currently eligible without deleting it.
lawn system images prune --dry-run
lawn system images prune

lawn system cli install

Create a symlink to the lawn binary in /usr/local/bin, making it available system-wide.

lawn system cli install

lawn system cli uninstall

Remove the lawn symlink from /usr/local/bin.

lawn system cli uninstall

lawn system config update-snapshots

Read or change update Snapshot retention. Values are delete-after-update, 30-days (the default), and keep.

Shortening retention requires confirmation and applies to existing and future update Snapshots. Existing Snapshots may be deleted. In an interactive terminal, Lawn prompts for confirmation. For unattended calls or JSON output, pass --yes to confirm.

OptionDescription
-y, --yesConfirm shorter retention for existing and future update Snapshots.
# Show the current setting
lawn system config update-snapshots

# Keep update Snapshots for 30 days
lawn system config update-snapshots 30-days

# Confirm shorter retention without a prompt
lawn system config update-snapshots delete-after-update --yes

# Confirm shorter retention with JSON output
lawn --output json system config update-snapshots 30-days --yes

lawn system config prevent-sleep

Read or change the preference to prevent idle sleep while at least one app is running and the Mac is connected to AC power. Desktop Macs are always treated as connected to AC power.

status is the default action. It reports whether the preference is enabled, not whether Lawn is currently preventing idle sleep.

# Show the current preference
lawn system config prevent-sleep
lawn system config prevent-sleep status

# Enable idle sleep prevention
lawn system config prevent-sleep enable

# Disable idle sleep prevention
lawn system config prevent-sleep disable

lawn system config show-debugging-apps

Show or hide debugging apps in the catalog. This command is available in release builds, where the preference defaults to disabled.

The preference belongs to the local Lawn identity. It does not configure the host selected with --server or LAWN_SERVER.

# Show the current preference (status is the default action)
lawn system config show-debugging-apps
lawn system config show-debugging-apps status

# Show debugging apps
lawn system config show-debugging-apps enable

# Hide debugging apps
lawn system config show-debugging-apps disable

lawn system config mirror list

List all configured registry mirrors.

lawn system config mirror list

Aliases: ls

lawn system config mirror set

Set a mirror URL for a registry domain.

lawn system config mirror set <registry> <mirror-url>
# Mirror Docker Hub through a local cache
lawn system config mirror set docker.io https://mirror.local:5000

lawn system config mirror remove

Remove a configured mirror.

lawn system config mirror remove <registry>

Aliases: rm

lawn system config mirror remove docker.io

lawn system config experiments list

List available experimental features. No experiments are available in this release, so there is nothing to enable or disable.

lawn system config experiments list

Aliases: ls