CLI Reference
Complete command-line interface reference for DeviceSDK
The devicesdk CLI is the main way to create projects, deploy scripts, flash firmware, and inspect devices.
Installation
Install the CLI via npm:
npm install -g @devicesdk/cli
Or use it directly with npx:
npx @devicesdk/cli [command]
Authenticating
Run devicesdk login to authenticate against your self-hosted server - the CLI auto-discovers it via mDNS. Use --host <url> if mDNS isn't available on your network, you're using a custom MDNS_HOSTNAME, or the CLI runs on the same machine as the server. Credentials are stored in ~/.devicesdk/credentials.json.
Pages in this section
devicesdk build
Bundle device scripts and regenerate inter-device RPC types
devicesdk deploy
Deploy device scripts to the DeviceSDK server you run
devicesdk dev
Run the local development simulator for DeviceSDK device scripts
devicesdk flash
Flash firmware to Raspberry Pi Pico and ESP32
devicesdk init
Create a new DeviceSDK project
devicesdk inspect
Interactive REPL for sending hardware commands to a connected device
devicesdk login
Authenticate the CLI against the DeviceSDK server you run
devicesdk logs
View and stream log output from a deployed device
devicesdk status
Check the connection status of devices in your project