Overview
Control Lawn from the command line with the lawn CLI.
The lawn CLI gives you full control over Lawn from the terminal.
Installation
Open Lawn's settings, go to the CLI tab, and click Install. This creates a symlink at /usr/local/bin/lawn so you can use it from any terminal session.
You can also install (or reinstall) the CLI from the terminal if you already have access to the lawn binary:
lawn system cli install
To uninstall:
lawn system cli uninstall
Quick Start
# List available apps
lawn catalog list
# Install an app
lawn catalog install whoami
# See your installed apps
lawn app list
# Start and stop an app
lawn app start whoami
lawn app stop whoami
# View logs
lawn app logs whoami --follow
# Remove an app
lawn app remove whoami
Global Options
These flags work with any command:
| Flag | Description |
|---|---|
--socket <path> | Path to the engine socket (auto-detected by default) |
-o, --output <format> | Output format: table (default) or json |
Use --output json for scripting and automation.
Shell Completions
Generate tab completions for your shell:
# Bash
lawn completions bash > /usr/local/etc/bash_completion.d/lawn
# Zsh
lawn completions zsh > ~/.zsh/completions/_lawn
# Fish
lawn completions fish > ~/.config/fish/completions/lawn.fish
Command Groups
lawn catalog
Browse, search, and install apps from the catalog.
lawn app
Manage installed app instances — lifecycle, logs, configuration, and more.
lawn system
System-level commands for CLI setup, network checks, and registry mirrors.
lawn compose
Validate and test Lawn compose files locally. Coming soon.
lawn template
Scaffold, validate, and test app templates. Coming soon.
Continue reading