1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
| # yaml-language-server: $schema=../../cfg/config.schema.json
#
# Shelly CLI - Full Configuration Reference
#
# This file documents ALL available configuration options.
# Copy to ~/.config/shelly/config.yaml and customize as needed.
#
# For a minimal starting configuration, see: examples/config/minimal.yaml
# For multi-location setups, see: examples/config/multi-site.yaml
#
# Run 'shelly init' for guided setup, or 'shelly init --check' to verify.
# =============================================================================
# Global Settings
# =============================================================================
# Output format: table, json, yaml, text, template
output: table
# Enable colored output (respects NO_COLOR env var)
color: true
# Color theme (280+ themes available, run 'shelly theme list' to see all)
# Popular choices: dracula, nord, tokyo-night, gruvbox, catppuccin, one-dark
#
# Simple format - just the theme name:
theme: dracula
#
# Block format - theme name with color overrides:
# theme:
# name: dracula
# colors:
# green: "#50fa7b"
# red: "#ff5555"
#
# External file format - load from a theme file:
# theme:
# file: ~/.config/shelly/themes/my-theme.yaml
#
# Full custom format - only custom colors (no base theme):
# theme:
# colors:
# foreground: "#f8f8f2"
# background: "#282a36"
# green: "#50fa7b"
# red: "#ff5555"
# yellow: "#f1fa8c"
# blue: "#6272a4"
# cyan: "#8be9fd"
# purple: "#bd93f9"
# bright_black: "#6272a4"
#
# Semantic color overrides - customize meaning-based colors:
# theme:
# name: dracula
# semantic:
# # UI colors
# primary: "#ff79c6" # Pink instead of purple for main actions
# secondary: "#6272a4" # Supporting elements
# highlight: "#ffb86c" # Orange for emphasis
# muted: "#6272a4" # Less important content
#
# # Feedback colors
# success: "#50fa7b" # Green for success
# warning: "#f1fa8c" # Yellow for warnings
# error: "#ff5555" # Red for errors
# info: "#8be9fd" # Cyan for info
#
# # Device state colors
# online: "#50fa7b" # Green when online
# offline: "#ff5555" # Red when offline
# updating: "#f1fa8c" # Yellow while updating
# idle: "#6272a4" # Gray when idle
#
# # Table styling colors
# table_header: "#8be9fd" # Cyan headers
# table_cell: "#f1fa8c" # Yellow cells
# table_alt_cell: "#ffb86c" # Orange alternating cells
# table_border: "#bd93f9" # Purple borders
# API mode: local (direct device access), cloud (via Shelly Cloud), auto
api_mode: local
# Verbosity level (0=silent, 1=info, 2=debug, 3=trace)
# Can also be set via -v/-vv/-vvv flags
verbosity: 0
# Suppress non-essential output
quiet: false
# Opt-in anonymous usage telemetry (disabled by default)
# When enabled, sends command usage statistics to help improve the CLI.
# Only collects: command name, success/failure, version, OS, duration.
# Does NOT collect: device info, IPs, personal data, credentials.
# telemetry: true
# Preferred editor for 'shelly config edit'
# Falls back to $EDITOR, $VISUAL, then nano
# editor: vim
# =============================================================================
# Logging Settings (for debugging)
# =============================================================================
log:
# Log output format: false=human-readable, true=JSON (for log aggregation)
json: false
# Filter logs by category (comma-separated)
# Available: network, config, device, api, auth, plugin, discovery, firmware
# Example: "network,api" to only see network and API logs
# Leave empty to see all categories
categories: ""
# =============================================================================
# Discovery Settings
# =============================================================================
discovery:
# Discovery timeout
timeout: 10s
# Enable mDNS discovery (recommended for Gen2+ devices)
mdns: true
# Enable Bluetooth LE discovery
ble: false
# Enable CoIoT discovery (Gen1 devices)
coiot: false
# Default network for subnet scanning (CIDR notation)
# network: 192.168.1.0/24
# =============================================================================
# Shelly Cloud Settings (optional)
# =============================================================================
cloud:
# Enable cloud integration for remote access
enabled: false
# Cloud account email (set via 'shelly cloud login')
# email: user@example.com
# Tokens are managed automatically - do not edit manually
# access_token: ""
# refresh_token: ""
# Cloud server URL (default is Shelly's production server)
server_url: https://shelly-api.shelly.cloud
# =============================================================================
# Integrator Settings (for OEM/partners)
# =============================================================================
# Shelly Integrator API credentials for partner integrations.
# Environment variables take precedence: SHELLY_INTEGRATOR_TAG, SHELLY_INTEGRATOR_TOKEN
#
# integrator:
# tag: my-partner-tag
# token: my-integrator-token
# =============================================================================
# Registered Devices
# =============================================================================
# Devices can be added via:
# shelly device add <name> <address>
# shelly discover mdns --register
# shelly init (guided setup)
devices:
# Example device entries:
#
# kitchen-light:
# address: 192.168.1.50
# generation: 2
# type: switch
# model: SHSW-PM
#
# desk-lamp:
# address: 192.168.1.51
# generation: 2
# type: plug
# model: SHPLG-S
# auth:
# username: admin
# password: secret123
#
# living-room-dimmer:
# address: 192.168.1.52
# generation: 2
# type: light
# model: SHDM-2
# =============================================================================
# Command Aliases
# =============================================================================
# Create shortcuts for frequently used commands.
# Use $1, $2, etc. for positional arguments, $@ for all arguments.
aliases:
# Example aliases:
#
# lights-off:
# command: batch off kitchen-light living-room desk-lamp
#
# status:
# command: device list --output table
#
# morning:
# command: scene activate morning-routine
#
# # Shell alias (enables pipes and redirects)
# backup-all:
# command: shelly backup create --all | gzip > ~/shelly-backup.gz
# shell: true
# =============================================================================
# Device Groups
# =============================================================================
# Group devices for batch operations:
# shelly batch on --group living-room
groups:
# Example groups:
#
# living-room:
# devices:
# - living-room-light
# - living-room-lamp
# - tv-backlight
#
# bedroom:
# devices:
# - bedroom-light
# - nightstand-lamp
#
# all-lights:
# devices:
# - kitchen-light
# - living-room-light
# - bedroom-light
# =============================================================================
# Scenes
# =============================================================================
# Save and recall device states:
# shelly scene activate movie-time
# shelly scene save current-state
scenes:
# Example scenes:
#
# movie-time:
# description: Dim lights for movie watching
# actions:
# - device: living-room-dimmer
# method: Light.Set
# params:
# id: 0
# on: true
# brightness: 20
# - device: tv-backlight
# method: Light.Set
# params:
# id: 0
# on: true
# brightness: 50
#
# all-off:
# description: Turn off all lights
# actions:
# - device: kitchen-light
# method: Switch.Set
# params:
# id: 0
# on: false
# - device: living-room-light
# method: Switch.Set
# params:
# id: 0
# on: false
# =============================================================================
# Templates
# =============================================================================
# Reusable configuration templates for devices and scripts.
# Create templates with 'shelly template create' or 'shelly script template'.
templates:
# Device configuration templates
# device:
# my-switch-config:
# name: my-switch-config
# description: Standard switch configuration
# model: SNSW-001X16EU
# generation: 2
# config:
# switch:0:
# name: Main Switch
# initial_state: restore_last
# source_device: living-room
# Script templates
# script:
# motion-light:
# name: motion-light
# description: Turn on light when motion detected
# code: |
# // Motion-activated light script
# let TIMEOUT = 300; // seconds
# Shelly.addEventHandler(function(event) {
# if (event.component === "input:0" && event.info.state) {
# Shelly.call("Switch.Set", {id: 0, on: true});
# Timer.set(TIMEOUT * 1000, false, function() {
# Shelly.call("Switch.Set", {id: 0, on: false});
# });
# }
# });
# category: automation
# variables:
# - name: TIMEOUT
# description: Auto-off timeout in seconds
# type: number
# default: 300
# min_gen: 2
# =============================================================================
# Alerts
# =============================================================================
# Device monitoring alerts. Create with 'shelly alert create'.
#
# alerts:
# kitchen-offline:
# name: kitchen-offline
# description: Alert when kitchen device goes offline
# device: kitchen
# condition: offline
# action: notify
# enabled: true
#
# high-power:
# name: high-power
# description: Alert when power exceeds threshold
# device: living-room
# condition: "power>1000"
# action: "webhook:https://example.com/alert"
# enabled: true
# =============================================================================
# Rate Limiting Settings
# =============================================================================
# Rate limiting prevents overloading Shelly devices.
# Gen1 (ESP8266) supports max 2 concurrent connections.
# Gen2 (ESP32) supports max 5 concurrent transactions.
# These defaults are tuned for stability - customize only if needed.
ratelimit:
gen1:
min_interval: 2s # Min time between requests to same device
max_concurrent: 1 # Max in-flight requests per device
circuit_threshold: 5 # Failures before circuit breaker opens
gen2:
min_interval: 500ms
max_concurrent: 3
circuit_threshold: 5
global:
max_concurrent: 5 # Total concurrent requests across all devices
circuit_open_duration: 60s # How long circuit stays open
circuit_success_threshold: 2 # Successes needed to close circuit
# =============================================================================
# Plugin Settings
# =============================================================================
plugins:
# Enable plugin system
enabled: false
# Additional plugin search paths (beyond ~/.config/shelly/plugins)
# path:
# - /usr/local/share/shelly/plugins
# - ~/my-shelly-plugins
# =============================================================================
# TUI Dashboard Settings
# =============================================================================
tui:
# Auto-refresh interval in seconds (1-300)
refresh_interval: 5
# TUI-specific theme (independent - completely replaces main theme when set)
# Supports same formats as main theme: string, block with colors, or file
# theme: nord
# theme:
# name: tokyo-night
# colors:
# green: "#9ece6a"
# Custom keybindings (uncomment to override defaults)
# keybindings:
# # Navigation (vim-style by default)
# up: [up, k]
# down: [down, j]
# left: [left, h]
# right: [right, l]
#
# # Actions
# toggle: [space, t]
# turn_on: ["1", o]
# turn_off: ["0", x]
# refresh: [r, ctrl+r]
# filter: ["/"]
# command: [":"]
# help: ["?"]
# quit: [q, ctrl+c]
#
# # View switching
# tab: [tab]
# shift_tab: [shift+tab]
# view1: ["1"]
# view2: ["2"]
# view3: ["3"]
# view4: ["4"]
|