Overview

General Usage

❗ NOTE: If you're here to use the CLI, you can go directly to the README for the cli package.

❗ NOTE: This CLI is currently considered an alpha release. It has currently has only a few specific features implemented and is a work in progress.

Build Informtion

This is the monorepo for the SmartThings CLI. Currently, the following packages are included:

• cli - the CLI itself; @smartthings/cli node package
• lib - a library for use in the CLI and its extensions; @smartthings/cli-lib node package
• testlib - a library for use in the CLI and its extensions with utility methods to make testing with Jest easier; @smartthings/cli-testlib node package

Development

The CLI uses lerna to manage multiple packages in a monorepo.

The CLI depends on the SmartThings Core SDK which is not yet published. To get this working for testing purposes, you'll need to check out both repositories and then:

1. Be sure you're using at least NodeJS version 12.
2. In the root directory of the SDK
   1. run npm install.
   2. run npm link. If you're using a globally-installed version of node, you might need to run this with admin privileges.
3. Install lerna globally with npm -g i lerna. (Alternatively, you can use npx lerna below instead of simply lerna.)
4. In the in the root directory of the CLI repository run ./bootstrap.sh.
5. The bootstrap script will compile the CLI but you can:
   1. run lerna run compile to compile again, or
   2. run lerna run watch to watch for changes and compile on the fly, or
   3. run lerna run build to clean and compile
6. To run the CLI, run the run command in packages/cli/bin. You can create a link to this file to make it easier to run. Since the final installed name will be "smartthings", that's a good name for the link. For example: ln -s ~/mydevdir/smartthings-cli/packages/cli/bin/run ~/bin/smartthings

There is also a full_clean.sh script you can run to start over again. This is sometimes helpful when pulling new code.

Before opening a pull request be sure to:

1. Run eslint via lerna run lint
2. Run tests with lerna run test
3. If you've added or or removed commands or updated any of their arguments or flags, be sure to update the readme. Doing a full build via lerna run build will do this but you can also run lerna run readme.