CLI Reference
Command Line Interface
Complete reference for all available sms-dev CLI commands.
Installation
Global Installation
npm install -g @relay-works/sms-devProject Installation
npm install --save-dev @relay-works/sms-devCore Commands
sms-dev start
AvailableStart the sms-dev development environment (API server + Virtual Phone UI).
Usage
sms-dev start [options]Options
-c, --config <file>Configuration file path-p, --api-port <port>API server port (default: 4001)-u, --ui-port <port>UI server port (default: 4000)--no-uiStart only the API server--webhook-url <url>Webhook URL for testing--verboseEnable verbose logging--show-configShow resolved configuration and exitExamples
Start with default ports:
sms-dev startStart with webhook URL:
sms-dev start --webhook-url http://localhost:3000/webhookStart API only (no UI):
sms-dev start --no-ui --verbosesms-dev stop
AvailableStop the sms-dev server and all running processes.
Usage
sms-dev stopsms-dev status
AvailableCheck the status of sms-dev servers and display connection information.
Usage
sms-dev statusConfiguration Commands
sms-dev init
AvailableGenerate a sample configuration file for customizing sms-dev behavior.
Usage
sms-dev init [options]Options
-f, --forceOverwrite existing configuration file--jsonGenerate JSON configuration instead of JavaScriptExamples
Generate JavaScript config:
sms-dev initGenerate JSON config:
sms-dev init --jsonsms-dev config
AvailableShow the current resolved configuration from all sources.
Usage
sms-dev config [options]Options
-c, --config <file>Configuration file pathHelp Commands
sms-dev docs
AvailableDisplay documentation links and quick command reference.
Usage
sms-dev docssms-dev --help
AvailableDisplay help information for all commands and options.
Usage
sms-dev --helpNext Steps
Configuration Guide
Learn how to customize sms-dev with configuration files and environment variables.
Read Configuration Guide →