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
[--distributor-type ]
[--common-name ]
[--organization ][--organizational-unit
[--locality ]
[--state ]
[--country ]

Device authentication

Action Command
Request device certificate st request device-crt --device-name
[--email ]
[--mnid ]
[--common-name ]
[--organization ]
[--organizational-unit ]
[--locality ]
[--state ]
[--country ]
[--out-dir ]

Project management

Action Command
Create project st create project -n,--name
--vid
[--device-plugin ]
[--create-device-plugin]
List project st list project
Build or package project st build project
Sign project st sign ppk
--in
[--out ]
--passwd
Verify signed project st verify ppk --in
--verbose
List project templates st list template [--device-profile ]
Create project using template st create project -n, --name
--template
Create project using a device profile st create project -n,--name
--device-profile
[--main-state
]

[--main-action
]

[--device-plugin ]
[--create-device-plugin]

Location management

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

Group management

Action Command
Create group st create group
-n,--name
[--parent ]
Describe group st describe group -i,--id
List groups st list group
Update group st update group -i,--id
-o,--operation
[--devices ]
[--members ]
Delete group st delete group -i,--id

Device profile management

Action Command
Create custom device profile st create device-profile --in
List device profile st list device-profile [--built-in]
[--category ]
Describe device Profile st describe device-profile --id [--resource-model]
Update custom device profile st update device-profile --id
--in
Delete custom device profile st delete device-profile --id

Device management and control

Action Command
List device st list device
--resource-model
--client
Describe device st describe device -i, --id
--resource-model [--detail]
Delete device st delete device -i,--id
Describe device status st describe device-status -i, --id
--component
--resource-model -r,--resource
Update device status st command device -i, --id
--capability
--command ;
--args
--component
[--resource-type ]
[--interface ]
Publish device st publish device -i, --id
--device profile
--authcode
[--name ]

Manage Manifest

Action Command
Register Manifest st register manifest
--type
--in
List Manifest st list manifest [--i,--id ]
[--type ]
[--status ]
[--owner-id ]
Describe Manifest st describe manifest --i,--id
--type
--mnmn
--vid
--version
Update Manifest st update manifest --i,--id
--in
Generate manifest st generate manifest [--capability ]
[--component ]
[--main-state
]

[--main-action
]

[--in ]
[--out-dir ]
Delete Manifest st delete manifest -i,--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 --resource-model
st describe resource-type -i,--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 --tail
Action Command
Describe standard capabilities st describe resource -type -i, --id