CLI Reference

Help

Action Command
List all SmartThings commands st
Launch help text st help
List definition for command st (behavior) --help
List definition for commands based on targets st (behavior) (target) --help

User authentication

Action Command
Request user authentication token st request-token [--show-ui]
Refresh authentication token st refresh-token
Request certificate signing for your PPK st request ppk-crt
--passwd <Password>
[--distributor-type <Distributor Type>]
[--common-name <Common Name>]
[--organization <Organization>][--organizational-unit <Organization Unit]
[--locality <Locality>]
[--state <State>]
[--country <Country>]

Device authentication

Action Command
Request device certificate st request device-crt --device-name <Device Name>
[--email <Email>]
[--mnid <Manufacturer ID>]
[--common-name <Common Name>]
[--organization <Organization>]
[--organizational-unit <Organizational Unit>]
[--locality <Locality>]
[--state <State>]
[--country <Country>]
[--out-dir <Output Cert File Directory>]

Project management

Action Command
Create project st create project -n,--name <Project Name>
--vid <Vendor ID>
[--plugin-id <Device-Plugin ID>]
[--generate-plugin]
List project st list project
Build or package project st build project
Sign project st sign ppk
--in <Input PPK File Path>
[--out <Output PPK File Path>]
--passwd <Issued ppk-crt password>
Verify signed project st verify ppk --in <input ppk file path>
--verbose
List project templates st list template [--device-profile <Device-Profile ID>]
Create project using template st create project -n, --name <project name>
--template <template ID>
Create project using a device profile st create project -n,--name <Project Name>
--device-profile <Device Profile ID>
[--main-state <Main State Capability>]
[--main-action <Main Action Capability>]
[--plugin-id <Device-Plugin ID>]
[--generate-plugin]

Location management

Action Command
Create location st create location -n, --name <location name>
--country-code <country code>
--latitude <latitude>
--longitude <longitude>
--radius <radius>
--temperature-scale <temperature scale>
Describe location st describe location -i, --id <location ID>
List location st list location
Update location st update location -i, --id <location ID>
-n,--name <Location Name>
--latitude <latitude>
--longitude <longitude>
--radius <radius>
--temperature-scale <temperature scale>
Delete location st delete location -i, --id <location ID>

Group management

Action Command
Create group st create group
-n,--name <Group Name>
[--parent <Parent Group ID>]
Describe group st describe group -i,--id <Group ID>
List groups st list group
Update group st update group -i,--id <Group ID>
-o,--operation <Operation Type>
[--devices <Device ID List>]
[--members <Member ID List>]
Delete group st delete group -i,--id <Group ID>

Device profile management

Action Command
Create custom device profile st create device-profile --in <Device info file path>
List device profile st list device-profile [--built-in]
[--category <Device Category Name>]
Describe device Profile st describe device-profile --id <Device Profile ID> [--resource-model]
Update custom device profile st update device-profile --id <Device Profile ID>
--in <Device Info File Path>
Delete custom device profile st delete device-profile --id <Device Profile ID>

Device management and control

Action Command
List device st list device
--resource-model
--client
Describe device st describe device -i, --id <Device ID>
--resource-model [--detail]
Delete device st delete device -i,--id <Device ID>
Describe device status st describe device-status -i, --id <Device ID>
--component <Component ID>
--resource-model -r,--resource <OCF Resource HREF>
Update device status st command device -i, --id <Device ID>
--capability <capability name>
--command <command>;
--args <command argument>
--component <component ID>
[--resource-type <OCF Resource Type>]
[--interface <OCF Interface>]
Publish device st publish device -i, --id <device ID>
--device profile <device profile ID>
--authcode <authentication code>
[--name <Device Name>]

Manage Manifest

Action Command
Register Manifest st register manifest
--type <Manifest Type>
--in <Manifest File Path>
List Manifest st list manifest [--i,--id <Workflow ID>]
[--type <Manifest Type>]
[--status <Submission Status>]
[--owner-id <User ID>]
Describe Manifest st describe manifest --i,--id <Workflow ID>
--type <Manifest Type>
--mnmn <Manufacturer ID>
--vid <Vendor ID>
--version <Version>
Update Manifest st update manifest --i,--id <Workflow ID>
--in <Manifest File Path>
Generate manifest st generate manifest [--capability <Capability ID>]
[--component <Component ID>]
[--main-state <Main State Capability ID>]
[--main-action <Main Action Capability ID>]
[--in <Device Profile File Path>]
[--out-dir <Output Path>]
Delete Manifest st delete manifest -i,--id <Workflow ID>

Standard capabilities

Action Command
List standard capability st list capability [--main-state]
[--main-action]
List resource types st list resource-type
Describe standard capability st describe capability -i,--id <Capability ID> --resource-model
st describe resource-type -i,--id <OCF Resource ID>

Simulator

Action Command
Install app on simulator st install app --simulator
Install app on target device st install app --target
Launch device simulator st launch virtual-device
Launch SmartThings simulator st launch simulator

Logs

Action Command
Get real-time logs st get log --device <Device ID> --tail
Action Command
Describe standard capabilities st describe resource -type -i, --id <Resource type ID>