Skip to content
grlx Docs

Managing Sprouts

The grlx sprouts command provides visibility into all sprouts known to the farmer — their connection status, key state, and properties.

List Sprouts

Section titled “List Sprouts”
Terminal window
grlx sprouts list

Shows all known sprouts sorted by connection status (connected first, then alphabetical). The output includes each sprout’s name, connection state, and key state.

Filter by state

Section titled “Filter by state”
Terminal window
# Only show sprouts with accepted keys
grlx sprouts list --state accepted


# Only show currently connected sprouts
grlx sprouts list --online

JSON output

Section titled “JSON output”
Terminal window
grlx sprouts list --out json

Inspect a Sprout

Section titled “Inspect a Sprout”
Terminal window
grlx sprouts show my-sprout

Displays detailed information about a single sprout, including its properties, connection history, and current status.

Key Management

Section titled “Key Management”

Before a sprout can receive commands, the farmer must accept its key. This is handled through the grlx auth subcommands rather than the sprouts command — see the Authentication section for details.

Connection Model

Section titled “Connection Model”

Sprouts connect to the farmer’s embedded NATS server on startup. The farmer tracks which sprouts are currently connected and their last-seen timestamps. Sprouts behind firewalls or NAT work fine — they only need outbound access to the farmer’s NATS port.