Skip to content

CLI reference

invis

Command-line tool for InvisOutlet smart outlets.

Usage:

invis [OPTIONS] COMMAND [ARGS]...

Options:

  --host TEXT  Device IP address (overrides the saved default).
  -y, --yes    Skip confirmation for destructive commands.
  --version    Show the version and exit.
  --help       Show this message and exit.

deco

Control the attached InvisDeco faceplate.

Usage:

invis deco [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

calibrate

Calibrate the faceplate's sensors.

Usage:

invis deco calibrate [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

climate

Calibrate temperature and humidity to reference values.

Usage:

invis deco calibrate climate [OPTIONS] TEMPERATURE HUMIDITY

Options:

  TEMPERATURE  Reference temperature in °C.  [required]
  HUMIDITY     Reference relative humidity in %.  [required]
  --help       Show this message and exit.

occupancy

Run occupancy-sensor calibration.

Usage:

invis deco calibrate occupancy [OPTIONS] SECONDS

Options:

  SECONDS  Calibration duration in seconds.  [required]
  --help   Show this message and exit.

reset

Reset the InvisDeco (clears air-quality calibration).

Usage:

invis deco reset [OPTIONS]

Options:

  --help  Show this message and exit.

restart

Restart the InvisDeco.

Usage:

invis deco restart [OPTIONS]

Options:

  --help  Show this message and exit.

default

Manage the default device.

Usage:

invis default [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

forget

Forget the saved default device.

Usage:

invis default forget [OPTIONS]

Options:

  --help  Show this message and exit.

select

Choose a device (via picker, or --host) and save it as the default.

Usage:

invis default select [OPTIONS]

Options:

  --host TEXT  Set this IP directly instead of running the picker.
  --help       Show this message and exit.

show

Show the saved default device.

Usage:

invis default show [OPTIONS]

Options:

  --help  Show this message and exit.

device

Inspect and manage the device.

Usage:

invis device [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

config

Show the full device configuration.

Usage:

invis device config [OPTIONS]

Options:

  --help  Show this message and exit.

info

Show device and sub-device information.

Usage:

invis device info [OPTIONS]

Options:

  --help  Show this message and exit.

reset

Reset the device.

Usage:

invis device reset [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

factory

Factory-reset the device, erasing all configuration.

Usage:

invis device reset factory [OPTIONS]

Options:

  --help  Show this message and exit.

network

Reset network settings (clears Matter commissioning).

Usage:

invis device reset network [OPTIONS]

Options:

  --help  Show this message and exit.

restart

Restart the device.

Usage:

invis device restart [OPTIONS]

Options:

  --help  Show this message and exit.

discover

Scan the local network for InvisOutlet devices via mDNS.

Usage:

invis discover [OPTIONS]

Options:

  --timeout FLOAT  Scan duration in seconds.  [default: 5.0]
  --help           Show this message and exit.

name

Manage accessory names.

Usage:

invis name [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

list

List the user-assigned accessory names.

Usage:

invis name list [OPTIONS]

Options:

  --help  Show this message and exit.

set

Rename a single accessory, preserving the others.

Usage:

invis name set [OPTIONS] ACCESSORY NAME

Options:

  ACCESSORY  Accessory index to rename.  [required]
  NAME       New accessory name.  [required]
  --help     Show this message and exit.

nightlight

Control the nightlight.

Usage:

invis nightlight [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

aura

Aura (color) nightlight.

Usage:

invis nightlight aura [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

color

Set the color (HSV).

Usage:

invis nightlight aura color [OPTIONS] HUE SATURATION

Options:

  HUE                             Hue 0–360.  [required]
  SATURATION                      Saturation 0–100.  [required]
  --bri, --brightness INTEGER RANGE
                                  Brightness 0–100.  [default: 100; 0<=x<=100]
  --off                           Turn the light off.
  --help                          Show this message and exit.

status

Show the current per-LED state.

Usage:

invis nightlight aura status [OPTIONS]

Options:

  --help  Show this message and exit.

temp

Set a white color temperature.

Usage:

invis nightlight aura temp [OPTIONS] KELVIN

Options:

  KELVIN                          Color temperature in Kelvin.  [required]
  --bri, --brightness INTEGER RANGE
                                  Brightness 0–100.  [default: 100; 0<=x<=100]
  --off                           Turn the light off.
  --help                          Show this message and exit.

pro

Plain (white) nightlight.

Usage:

invis nightlight pro [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

brightness

Set the nightlight brightness (turns it on).

Usage:

invis nightlight pro brightness [OPTIONS] LEVEL

Options:

  LEVEL   Brightness 0–100.  [required]
  --help  Show this message and exit.

off

Turn the nightlight off.

Usage:

invis nightlight pro off [OPTIONS]

Options:

  --help  Show this message and exit.

on

Turn the nightlight on (keeping its current brightness).

Usage:

invis nightlight pro on [OPTIONS]

Options:

  --help  Show this message and exit.

status

Show the nightlight power state.

Usage:

invis nightlight pro status [OPTIONS]

Options:

  --help  Show this message and exit.

ota

Firmware updates.

Usage:

invis ota [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

check

Show available firmware updates.

Usage:

invis ota check [OPTIONS]

Options:

  --help  Show this message and exit.

update

Start an OTA update and stream progress until it completes.

Usage:

invis ota update [OPTIONS] TARGET:{outlet|deco}

Options:

  TARGET:{outlet|deco}        Which module to update.  [required]
  --method [wifi|via-outlet]  Delivery method (faceplate only).  [default:
                              wifi]
  --help                      Show this message and exit.

outlet

Control the outlets.

Usage:

invis outlet [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

off

Turn an outlet off.

Usage:

invis outlet off [OPTIONS] OUTLET

Options:

  OUTLET  Outlet number (1 or 2).  [required]
  --help  Show this message and exit.

on

Turn an outlet on.

Usage:

invis outlet on [OPTIONS] OUTLET

Options:

  OUTLET  Outlet number (1 or 2).  [required]
  --help  Show this message and exit.

status

Show the on/off state of each outlet.

Usage:

invis outlet status [OPTIONS]

Options:

  --help  Show this message and exit.

watch

Stream live sensor data until interrupted (Ctrl+C).

Usage:

invis watch [OPTIONS]

Options:

  --us    Show temperature, pressure and distance in US customary units.
  --help  Show this message and exit.