https://github.com/addono/teknicli

CLI interface for controlling TekniIoT devices.
https://github.com/addono/teknicli

Last synced: 6 months ago
JSON representation

CLI interface for controlling TekniIoT devices.

• Host: GitHub
• URL: https://github.com/addono/teknicli
• Owner: Addono
• License: mit
• Created: 2020-12-05T18:55:58.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-12-11T23:58:33.000Z (over 3 years ago)
• Last Synced: 2024-04-14T05:47:25.003Z (almost 2 years ago)
• Language: TypeScript
• Homepage: https://gitlab.com/tekniot/
• Size: 508 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
TekniCLI

========

Control your TekniLights from the command line.

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/teknicli.svg)](https://npmjs.org/package/teknicli)

[![Codecov](https://codecov.io/gh/Addono/teknicli/branch/master/graph/badge.svg)](https://codecov.io/gh/Addono/teknicli)

[![Downloads/week](https://img.shields.io/npm/dw/teknicli.svg)](https://npmjs.org/package/teknicli)

[![License](https://img.shields.io/npm/l/teknicli.svg)](https://github.com/Addono/teknicli/blob/master/package.json)

* [Usage](#usage)

* [Commands](#commands)

# Usage

```sh-session

$ npm install -g teknicli

$ teknicli COMMAND

running command...

$ teknicli (-v|--version|version)

teknicli/1.0.0 linux-x64 node-v12.20.0

$ teknicli --help [COMMAND]

USAGE

  $ teknicli COMMAND

...

```

# Commands

* [`teknicli brightness [BRIGHTNESS]`](#teknicli-brightness-brightness)

* [`teknicli help [COMMAND]`](#teknicli-help-command)

* [`teknicli off`](#teknicli-off)

* [`teknicli on`](#teknicli-on)

## `teknicli brightness [BRIGHTNESS]`

Set the brightness of the light

```

USAGE

  $ teknicli brightness [BRIGHTNESS]

OPTIONS

  -h, --help  show CLI help

```

_See code: [src/commands/brightness.ts](https://github.com/Addono/teknicli/blob/v1.0.0/src/commands/brightness.ts)_

## `teknicli help [COMMAND]`

display help for teknicli

```

USAGE

  $ teknicli help [COMMAND]

ARGUMENTS

  COMMAND  command to show help for

OPTIONS

  --all  see all commands in CLI

```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.0/src/commands/help.ts)_

## `teknicli off`

Turns the light off

```

USAGE

  $ teknicli off

OPTIONS

  -h, --help  show CLI help

```

_See code: [src/commands/off.ts](https://github.com/Addono/teknicli/blob/v1.0.0/src/commands/off.ts)_

## `teknicli on`

Turns the light on with maximum brightness

```

USAGE

  $ teknicli on

OPTIONS

  -h, --help  show CLI help

```

_See code: [src/commands/on.ts](https://github.com/Addono/teknicli/blob/v1.0.0/src/commands/on.ts)_