Skip to content

lf examples

Display common CLI usage examples grouped by category. Useful for discovering common workflows without reading full documentation.

bash
lf examples [--category <name>] [--json]

Flags

FlagTypeDefaultDescription
--categorystringallFilter examples by category
--jsonbooleanfalseOutput examples as JSON

Categories

CategoryDescription
getting-startedInitialize a project, authenticate, check status
lensesCreate, version, and publish Lenses
battlesLocal and cloud Battle workflows
workflowsSimulate and validate Workflows
teamsCreate and dispatch Agent Teams
diagnosticsEnvironment checks (lf doctor, lf env)
automationRecurring schedules and triggers

Examples

bash
# Show all examples
lf examples

# Filter by category
lf examples --category battles
lf examples --category getting-started

# JSON output for scripting
lf examples --json | jq '.[].commands'