Shelly CLI
Docs

shelly repl

shelly repl

Launch interactive REPL

Synopsis

Launch an interactive REPL (Read-Eval-Print Loop) for Shelly CLI.

This provides a command-line shell where you can enter Shelly commands without prefixing them with ‘shelly’. It supports command history and readline-style line editing (arrow keys, Ctrl+A/E, etc.).

Available commands in REPL: help Show available commands devices List registered devices connect Set active device for subsequent commands disconnect Clear active device status Show status of active device on Turn on all device components off Turn off all device components toggle Toggle all device components rpc Execute raw RPC call on active device exit, quit, q Exit the REPL

To control a specific component (e.g., switch ID 1 on a multi-switch device), use the rpc command with the appropriate method and parameters.

1

shelly repl [flags]

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

  # Start REPL mode
  shelly repl

  # Start with a default device
  shelly repl --device living-room

  # Example session:
  > devices
  > connect living-room
  > status
  > on
  > exit

  # Control specific switch on multi-switch device (after connecting):
  > connect dual-switch
  > rpc Switch.Set {"id":1,"on":true}
  > rpc Switch.Toggle {"id":0}

  # Or without connecting first (device as first arg):
  > rpc dual-switch Switch.Set {"id":1,"on":true}

Options

1
2
3

  -d, --device string   Default device to connect to
  -h, --help            help for repl
      --no-prompt       Disable interactive prompt (for scripting)

Options inherited from parent commands

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

      --config string           Config file (default $HOME/.config/shelly/config.yaml)
  -F, --fields                  Print available field names for use with --jq and --template
  -Q, --jq stringArray          Apply jq expression to filter output (repeatable, joined with |)
      --log-categories string   Filter logs by category (comma-separated: network,api,device,config,auth,plugin)
      --log-json                Output logs in JSON format
      --no-color                Disable colored output
      --no-headers              Hide table headers in output
      --offline                 Only read from cache, error on cache miss
  -o, --output string           Output format (table, json, yaml, template) (default "table")
      --plain                   Disable borders and colors (machine-readable output)
  -q, --quiet                   Suppress non-essential output
      --refresh                 Bypass cache and fetch fresh data from device
      --template string         Go template string for output (use with -o template)
  -v, --verbose count           Increase verbosity (-v=info, -vv=debug, -vvv=trace)

SEE ALSO

  • shelly - CLI for controlling Shelly smart home devices