System Requirements
- Node.js 18.0 or higher
- npm 8.0 or higher (or yarn/pnpm equivalent)
- macOS, Windows, or Linux
- Available ports 4000 and 4001 (configurable)
Global Installation (Recommended)
Install sms-dev globally to use it from anywhere on your system.
npm install -g @relay-works/sms-dev sms-dev start
Local Installation
Install sms-dev as a development dependency in your project.
npm install --save-dev @relay-works/sms-dev npx @relay-works/sms-dev start
Use Without Installing
Run sms-dev directly without installing it first using npx.
npx @relay-works/sms-dev start
Verify Installation
Confirm that sms-dev is installed correctly by checking the version.
Check version
sms-dev --version # Output: 1.0.0
View help
sms-dev --help # Output: # Usage: sms-dev [options] [command] # # Local SMS development tool # # Options: # -V, --version display version number # -h, --help display help for command # # Commands: # start [options] Start the SMS development environment # stop Stop running services # status Show service status # help [command] display help for command
First Run
Start sms-dev to make sure everything is working correctly.
Start sms-dev
sms-dev start # Expected output: # 🚀 Starting sms-dev... # ✅ API Server: http://localhost:4001 # ✅ Virtual Phone: http://localhost:4000 # # Ready for SMS development! # Press Ctrl+C to stop
Success!
If you see the above output, sms-dev is installed and running correctly. You can now visit http://localhost:4000 to see the Virtual Phone UI.
Troubleshooting
Port already in use
If ports 4000 or 4001 are already in use, you can specify different ports:
sms-dev start --api-port 5001 --ui-port 5000
Permission denied (EACCES)
If you get permission errors, try installing without sudo using npm config:
npm config set prefix ~/.npm-global export PATH=~/.npm-global/bin:$PATH npm install -g @relay-works/sms-dev
Command not found
If sms-dev command is not found after installation, check your PATH or use npx:
npx @relay-works/sms-dev start