Skip to content

Senses - Smart Mirror CLI to create and provision widgets

License

Notifications You must be signed in to change notification settings

senses-smart-mirror/senses-cli

Repository files navigation



Senses - Smart Mirror CLI

CLI tool for installing Senses - Software and creating & provisioning widgets to the Senses Smart Mirror.

Version License

Usage

$ npm install -g @senses-mirror/senses-cli
$ senses COMMAND
running command...
$ senses (-v|--version|version)
@senses-mirror/senses-cli/1.0.7 darwin-x64 node-v14.18.3
$ senses --help [COMMAND]
USAGE
  $ senses COMMAND
...

Commands

senses help [COMMAND]

display help for senses

USAGE
  $ senses help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

senses senses:install

Install the Senses - Smart Mirror software.

USAGE
  $ senses senses:install

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ senses install
  $ senses i

See code: src/commands/senses/install.ts

senses senses:run

Run the Senses - Smart Mirror software

USAGE
  $ senses senses:run

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ senses run
  $ senses r

See code: src/commands/senses/run.ts

senses widget:build [WIDGET]

Build (and zip) widget so widget is for the Senses - Smart Mirror.

USAGE
  $ senses widget:build [WIDGET]

ARGUMENTS
  WIDGET  The widget that should be build

OPTIONS
  -f, --force
  -h, --help           show CLI help
  -w, --widget=widget  specify the widget it should be build

See code: src/commands/widget/build.ts

senses widget:build-import [WIDGET] [TARGET]

Build & Provision (import) a widget for the Smart Mirror.

USAGE
  $ senses widget:build-import [WIDGET] [TARGET]

ARGUMENTS
  WIDGET  The widget that should be build
  TARGET  Target IP address.

OPTIONS
  -h, --help           show CLI help
  -t, --target=target  specify the target to where it should import
  -w, --widget=widget  specify the widget it should be build

See code: src/commands/widget/build-import.ts

senses widget:create [NAME] [LOCATION]

Scaffold a widget for the Senses - Smart Mirror.

USAGE
  $ senses widget:create [NAME] [LOCATION]

ARGUMENTS
  NAME      The name of the Widget
  LOCATION  Location where the widget should be created

OPTIONS
  -f, --force
  -h, --help               show CLI help
  -l, --location=location  location where to create the widget
  -n, --name=name          name to widget

See code: src/commands/widget/create.ts

senses widget:import [WIDGET] [TARGET]

Provision (import) a widget to Senses - Smart Mirror.

USAGE
  $ senses widget:import [WIDGET] [TARGET]

ARGUMENTS
  WIDGET  The widget that should be imported.
  TARGET  Target IP address.

OPTIONS
  -f, --force
  -h, --help           show CLI help
  -t, --target=target  specify the target to where it should import
  -w, --widget=widget  specify the widget it should be build

See code: src/commands/widget/import.ts

Special Thanks

With special thanks to Petar Blazevski for helping out with creating the CLI.

About

Senses - Smart Mirror CLI to create and provision widgets

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published