CLI Reference
Complete command-line interface reference for DeviceSDK
Installation
Install the CLI via npm:
npm install -g @devicesdk/cli
Or use it directly with npx:
npx @devicesdk/cli [command]
Configuration
The CLI is configured through devicesdk.ts in your project root:
export default {
devices: {
'my-device': './src/devices/my-device.ts'
}
}
Global Flags
All commands support these global flags:
--config <path>- Path to config file (default:devicesdk.ts)--verbose- Enable verbose logging--help- Show help for a command
Environment Variables
DEVICESDK_TOKEN- API authentication tokenDEVICESDK_API_URL- API endpoint (default: production)
Available Commands
Development
- devicesdk init - Create a new project
Deployment
- devicesdk deploy - Deploy to production
- devicesdk flash - Flash firmware to device
Getting Help
Run any command with --help to see detailed usage:
npx @devicesdk/cli deploy --help