@naarang/ccc 1.1.0-beta.2 → 1.1.0-beta.3

package/README.md

@@ -78,11 +78,11 @@ The server will start and display:
 ✓ Claude Chat Backend v1.1.0 started successfully
 
 Server URLs (Add one of these in the app settings):
-  Localhost: localhost:8080
-  Network:   192.168.1.100:8080
+  Localhost: localhost:8883
+  Network:   192.168.1.100:8883
 
 Services:
-  MQTT:      Port 8883 (via /mqtt)
+  MQTT:      Port 8884 (via /mqtt)
 ```
 
 ### 2. Configure the Mobile App
@@ -115,12 +115,12 @@ Options:
   --debug                           Enable debug logging
   -u, --username <user>             MQTT broker username
   -p, --password <pass>             MQTT broker password
-  --mqtt-port <port>                Internal MQTT broker port (default: 8883)
+  --mqtt-port <port>                Internal MQTT broker port (default: 8884)
   --port <port>                     [DEPRECATED] Use --mqtt-port instead
-  --router-port <port>              Router port for ngrok (default: 8080)
+  --router-port <port>              Internal Request Router port. This is what the app connects to (default: 8883)
   --terminal-port <port>            Internal terminal server port (default: 3001)
-  --terminal-username <user>        Terminal authentication username (enables terminal)
-  --terminal-password <pass>        Terminal authentication password (enables terminal)
+  --terminal-username <user>        Terminal authentication username
+  --terminal-password <pass>        Terminal authentication password
   -t, --ngrok-token <token>         ngrok auth token (enables public tunnel)
   --ngrok-domain <domain>           ngrok static domain
   --no-auto-update                  Disable automatic updates (enabled by default)
@@ -144,7 +144,11 @@ ccc -u admin -p secret
 
 **With terminal access (Beta):**
 ```bash
+# Using separate terminal credentials
 ccc --terminal-username admin --terminal-password secret
+
+# Or reuse MQTT credentials for terminal (if -u and -p are provided)
+ccc -u admin -p secret  # Terminal will also use these credentials
 ```
 
 **With ngrok for remote access:**
@@ -170,12 +174,12 @@ Create a `.env` file in your working directory:
 
 ```env
 # MQTT Configuration
-MQTT_BROKER_PORT=8883
+MQTT_BROKER_PORT=8884
 MQTT_USERNAME=your-username
 MQTT_PASSWORD=your-password
 
 # Router Configuration
-ROUTER_PORT=8080
+ROUTER_PORT=8883
 
 # Terminal Configuration (Beta)
 TERMINAL_PORT=3001
@@ -197,16 +201,29 @@ CCC now includes a built-in web terminal that can be accessed directly from the
 
 Terminal access is **opt-in** for security reasons. To enable it, you must provide authentication credentials:
 
+**Option 1: Using separate terminal credentials**
 ```bash
 ccc --terminal-username admin --terminal-password your-secure-password
 ```
 
-Or via environment variables:
+**Option 2: Reusing MQTT credentials** (fallback behavior)
+```bash
+# Terminal will automatically use MQTT credentials if terminal-specific ones aren't provided
+ccc -u admin -p your-secure-password
+```
+
+**Option 3: Via environment variables**
 ```env
 TERMINAL_USERNAME=admin
 TERMINAL_PASSWORD=your-secure-password
+
+# Or just set MQTT credentials
+MQTT_USERNAME=admin
+MQTT_PASSWORD=your-secure-password
 ```
 
+> **Note:** If you don't provide any credentials (neither terminal-specific nor MQTT), the terminal server will not start.
+
 ### How It Works
 
 1. **Architecture:**
@@ -318,9 +335,9 @@ CCC offers four permission modes to balance convenience and security:
 
 When you start CCC, it:
 
-1. **Starts MQTT Broker** - Embedded broker on port 8883 (localhost)
-2. **Starts Path Router** - HTTP router on port 8080 proxying MQTT and terminal
-3. **Starts Terminal Server** (Optional) - Web terminal on port 3001 if credentials provided
+1. **Starts MQTT Broker** - Embedded broker on port 8884 (localhost)
+2. **Starts Path Router** - HTTP router on port 8883 proxying MQTT and terminal
+3. **Starts Terminal Server** (Optional) - Web terminal on port 3001 if credentials provided (falls back to MQTT credentials)
 4. **Sets Up ngrok Tunnel** (Optional) - Public URL pointing to router
 5. **Sets Up Projects** - Auto-configures permission hooks
 6. **Manages Sessions** - Persistent sessions across disconnects
@@ -392,16 +409,19 @@ The CCC mobile app is required to interact with the backend.
 
 **Error: `EADDRINUSE: address already in use`**
 
-Another process is using port 8883:
+Another process is using the default ports. Find and kill the process, or use different ports:
 ```bash
-# Find the process
+# Find the process using router port (8883)
 lsof -i :8883
 
+# Or MQTT port (8884)
+lsof -i :8884
+
 # Kill it
 kill -9 <PID>
 
-# Or use a different port
-ccc --port 9000
+# Or use different ports
+ccc --router-port 9000 --mqtt-port 9001
 ```
 
 ### Connection Issues
@@ -411,8 +431,8 @@ ccc --port 9000
 **Checklist:**
 1. Check you're on the same WiFi network (for local)
 2. Verify server is running (`ccc` should show "started successfully")
-3. Check firewall settings allow port 8080 (router) and 8883 (MQTT)
-4. Use correct format: `hostname:port` (no `http://`)
+3. Check firewall settings allow port 8883 (router port that app connects to)
+4. Use correct format: `hostname:8883` (no `http://`)
 5. Enable debug mode: `ccc --debug`
 
 ### Permission Hook Errors
@@ -483,4 +503,38 @@ Make quick code changes without opening your laptop.
 Learn coding concepts by chatting with Claude from mobile.
 
 ### Pair Programming
-Co                                      @naarang/ccc && ccc`
+Collaborate with Claude on coding tasks remotely.
+
+## Comparison
+
+### vs Claude Web
+- ✅ Mobile access
+- ✅ Offline project access
+- ✅ Real-time streaming
+- ✅ Local file system access
+
+### vs Claude Desktop
+- ✅ Mobile control
+- ✅ Remote access
+- ✅ Multi-device support
+- ✅ Session persistence
+
+## Performance
+
+- **Startup Time**: ~2 seconds
+- **Response Latency**: <100ms (local network)
+- **Concurrent Sessions**: Unlimited
+- **Memory Usage**: ~150MB (varies with active sessions)
+
+## Support & Community
+
+- **Issues**: Report bugs and request features
+- **Discussions**: Ask questions and share ideas
+- **Updates**: Check npm for latest version
+- **Contact**: Email us at cccuiapp@gmail.com
+
+**Made with ❤️ by naarang**
+
+> **Note**: This tool requires an active Claude subscription and Claude Code to function properly.
+
+**Get Started:** `npm install -g @naarang/ccc && ccc`