thinkncollab-shell 0.0.4 → 0.0.6

package/Readme.md

@@ -1,26 +1,402 @@
-# ThinkNCollab Shell
+# ThinkNCollab Shell (`thinknsh`)
 
-A powerful collaborative shell with WebSocket integration for real-time team collaboration.
+A powerful collaborative shell with WebSocket integration for real-time team collaboration — built on top of the ThinkNCollab platform.
+
+---
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Configuration](#configuration)
+- [CLI Flags](#cli-flags)
+- [Interactive Shell](#interactive-shell)
+- [Commands Reference](#commands-reference)
+  - [Auth Commands](#auth-commands)
+  - [Team Commands](#team-commands)
+  - [Room Commands](#room-commands)
+  - [Message Commands](#message-commands)
+  - [Shell Commands](#shell-commands)
+- [Single-Command Mode](#single-command-mode)
+- [Built-in Shell Features](#built-in-shell-features)
+- [Examples](#examples)
+- [Environment Variables](#environment-variables)
+
+---
 
 ## Features
 
-- 🚀 **Custom Shell** - Full-featured command-line interface
-- 🔌 **WebSocket Integration** - Real-time communication with ThinkNCollab servers
-- 👥 **Room Collaboration** - Join rooms and collaborate with team members
-- 💬 **Messaging** - Send and receive messages in real-time
-- 🔔 **Notifications** - Get notified of important events
-- 📁 **File System** - Built-in file system commands
-- ⚡ **Command System** - Extensible command registration
-- 🔧 **Aliases** - Create custom command aliases
-- 📊 **Variables** - Shell variables support
-- 📜 **History** - Command history with persistence
-- 🎨 **Colored Output** - Beautiful colored terminal output
+- 🚀 **Custom Shell** — Full-featured interactive command-line interface
+- 🔌 **WebSocket Integration** — Real-time communication with ThinkNCollab servers
+- 👥 **Room Collaboration** — Join rooms and collaborate with teammates live
+- 💬 **Messaging** — Send and receive messages in real-time
+- 🔔 **Notifications** — Get notified of tasks, uploads, and room events
+- 📁 **File System** — Built-in file system commands (ls, cd, pwd, cat, mkdir)
+- ⚡ **Command System** — Extensible command registration by category
+- 🔧 **Aliases** — Create and manage custom command shortcuts
+- 📊 **Variables** — Shell variable support (`set`, `$VAR`)
+- 📜 **History** — Persistent command history across sessions
+- 🎨 **Colored Output** — Beautiful chalk-powered terminal output
+
+---
 
 ## Installation
 
 ```bash
-# Install globally
+# Install globally (recommended)
 npm install -g thinkncollab-shell
 
-# Or install locally
-npm install thinkncollab-shell
+# Or install locally in a project
+npm install thinkncollab-shell
+```
+
+After global install, the `thinknsh` binary is available everywhere on your system.
+
+---
+
+## Quick Start
+
+```bash
+# 1. Start the interactive shell
+thinknsh
+
+# 2. Log in to your ThinkNCollab account
+thinknsh> login
+
+# 3. Join a room
+thinknsh> join my-room
+
+# 4. Send a message
+thinknsh> say Hello team!
+
+# 5. Check your status
+thinknsh> status
+```
+
+---
+
+## Configuration
+
+By default `thinknsh` connects to `https://thinkncollab.com`. In production, set environment variables before starting the shell:
+
+```bash
+export THINKNCOLLAB_SERVER=https://thinkncollab.com
+export THINKNCOLLAB_API_URL=https://thinkncollab.com
+export THINKNCOLLAB_WS_URL=https://thinkncollab.com
+thinknsh
+```
+
+Or inline for a single session:
+
+```bash
+THINKNCOLLAB_SERVER=https://thinkncollab.com thinknsh
+```
+
+---
+
+## CLI Flags
+
+These flags are used **before** entering the interactive shell (passed directly to the `thinknsh` binary).
+
+| Flag | Alias | Description |
+|------|-------|-------------|
+| `--help` | `-h` | Show help message and exit |
+| `--version` | `-v` | Print the installed version and exit |
+
+```bash
+thinknsh --help
+thinknsh --version
+```
+
+---
+
+## Interactive Shell
+
+Running `thinknsh` with no arguments starts the **interactive shell** — a persistent REPL where you stay logged in, maintain a WebSocket connection, and run commands one after another.
+
+```
+$ thinknsh
+
+  ████████╗██╗  ██╗██╗███╗   ██╗██╗  ██╗███╗   ██╗
+     ╚══██╔╝██║  ██║██║████╗  ██║██║ ██╔╝████╗  ██║
+        ██║ ███████║██║██╔██╗ ██║█████╔╝ ██╔██╗ ██║
+        ██║ ██╔══██║██║██║╚██╗██║██╔═██╗ ██║╚██╗██║
+        ██║ ██║  ██║██║██║ ╚████║██║  ██╗██║ ╚████║
+        ╚═╝ ╚═╝  ╚═╝╚═╝╚═╝  ╚═══╝╚═╝  ╚═╝╚═╝  ╚═══╝
+
+thinknsh> _
+```
+
+Type `help` inside the shell to list all available commands at any time.
+
+---
+
+## Commands Reference
+
+### Auth Commands
+
+#### `login`
+Authenticate with your ThinkNCollab account. Prompts for email and password interactively.
+
+```bash
+thinknsh> login
+# Enter your email: you@example.com
+# Enter your password: ********
+# ✅ Logged in as you@example.com
+```
+
+#### `logout`
+End your current session and clear saved credentials.
+
+```bash
+thinknsh> logout
+# ✅ Logged out successfully
+```
+
+#### `whoami`
+Display information about the currently authenticated user.
+
+```bash
+thinknsh> whoami
+# 👤 Logged in as: Ramanh (raman@thinkncollab.com)
+# 🏢 Team: ThinkNCollab Core
+```
+
+---
+
+### Team Commands
+
+#### `myteam`
+Show details about your current team — name, plan, member count.
+
+```bash
+thinknsh> myteam
+# 🏢 Team: ThinkNCollab Core
+# 📋 Plan: Pro
+# 👥 Members: 8
+```
+
+#### `teammates`
+List all members in your team with their online status.
+
+```bash
+thinknsh> teammates
+# 👥 Team Members:
+#   🟢 Raman Singh       (you)
+#   🟢 Omkar Yadav
+#   🔴 Radhika Chauhan     (offline)
+#   🟡 --------------      (away)
+```
+
+#### `invite <email>`
+Send a team invitation to an email address.
+
+```bash
+thinknsh> invite newmember@example.com
+# ✅ Invitation sent to newmember@example.com
+```
+
+---
+
+### Room Commands
+
+#### `join <room-id>`
+Join a collaboration room. Establishes a WebSocket connection and streams live activity.
+
+```bash
+thinknsh> join room-abc123
+# 🚪 Joined room: room-abc123
+# 👥 Members online: 3
+# 📜 Recent activity loaded
+```
+
+You will automatically receive real-time notifications for messages, task updates, and file uploads while inside a room.
+
+#### `leave`
+Leave the currently active room and disconnect from its WebSocket stream.
+
+```bash
+thinknsh> leave
+# 👋 Left room: room-abc123
+```
+
+#### `rooms`
+List all rooms available to you — showing name, ID, and member count.
+
+```bash
+thinknsh> rooms
+# 📁 Your Rooms:
+#   [1] frontend-team    (ID: room-abc123)  👥 4 members
+#   [2] backend-infra    (ID: room-def456)  👥 2 members
+#   [3] design-review    (ID: room-ghi789)  👥 6 members
+```
+
+---
+
+### Message Commands
+
+#### `say <message>`
+Send a message to the room you are currently in. Requires you to be in a room (use `join` first).
+
+```bash
+thinknsh> say Hey team, PR is ready for review!
+# 💬 [You → frontend-team]: Hey team, PR is ready for review!
+```
+
+Supports multi-word messages — no quotes needed.
+
+```bash
+thinknsh> say Pushing the hotfix now, give me 5 minutes
+```
+
+---
+
+### Shell Commands
+
+#### `status`
+Show a full overview of your current shell session: auth status, active room, WebSocket connection, server URL, and version.
+
+```bash
+thinknsh> status
+# ──────────────────────────────────────
+#  ThinkNCollab Shell — Session Status
+# ──────────────────────────────────────
+#  User       : Raman Singh
+#  Email      : raman@example.com
+#  Server     : https://app.thinkncollab.com
+#  WebSocket  : ✅ Connected
+#  Active Room: frontend-team (room-abc123)
+#  Version    : 1.2.0
+# ──────────────────────────────────────
+```
+
+#### `help`
+List all registered commands grouped by category, with descriptions.
+
+```bash
+thinknsh> help
+```
+
+#### `clear`
+Clear the terminal screen.
+
+```bash
+thinknsh> clear
+```
+
+#### `exit` / `quit`
+Exit the interactive shell gracefully.
+
+```bash
+thinknsh> exit
+```
+
+---
+
+## Single-Command Mode
+
+You can run **any command as a one-liner** without entering the interactive shell. The shell executes the command and exits immediately — great for scripting or CI pipelines.
+
+```bash
+thinknsh status
+thinknsh whoami
+thinknsh join room-abc123
+thinknsh say "Deployment complete ✅"
+thinknsh rooms
+```
+
+Multi-word commands work naturally:
+
+```bash
+thinknsh say Build passed. Deploying to staging now.
+thinknsh invite contractor@example.com
+```
+
+---
+
+## Built-in Shell Features
+
+### Command History
+The interactive shell remembers your previously run commands across sessions. Use the **Up/Down arrow keys** to navigate history.
+
+### Aliases
+Create shortcuts for frequently used commands:
+
+```bash
+thinknsh> alias fe="join room-abc123"
+thinknsh> fe          # runs: join room-abc123
+```
+
+### Shell Variables
+Set and use variables within the shell:
+
+```bash
+thinknsh> set ROOM=room-abc123
+thinknsh> join $ROOM
+```
+
+### Tab Completion
+Press `Tab` to autocomplete commands and room names.
+
+### Piping & Chaining (Single-command mode)
+Chain commands using `&&` in your terminal:
+
+```bash
+thinknsh login && thinknsh join room-abc123 && thinknsh status
+```
+
+---
+
+## Examples
+
+```bash
+# Check who you are
+thinknsh whoami
+
+# See all your rooms, then join one
+thinknsh rooms
+thinknsh join room-abc123
+
+# Send a quick message without opening the shell
+thinknsh say "Hotfix deployed to production"
+
+# Invite a new member
+thinknsh invite dev@company.com
+
+# Full interactive session
+thinknsh
+thinknsh> login
+thinknsh> rooms
+thinknsh> join frontend-team
+thinknsh> say Good morning everyone 🚀
+thinknsh> teammates
+thinknsh> status
+thinknsh> exit
+```
+
+---
+
+## Environment Variables
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `THINKNCOLLAB_SERVER` | `https://thinkncollab.com` | Main server URL (REST + WebSocket base) |
+| `THINKNCOLLAB_API_URL` | `https://thinkncollab.com` | REST API base URL (overrides SERVER for API calls) |
+| `THINKNCOLLAB_WS_URL` | `https://thinkncollab.com` | WebSocket server URL |
+| `THINKNCOLLAB_AUTO_CONNECT` | `false` | Set to `true` to auto-connect WebSocket on shell start |
+
+In production, all three URL variables typically point to the same host:
+
+```bash
+export THINKNCOLLAB_SERVER=https://app.thinkncollab.com
+export THINKNCOLLAB_API_URL=https://app.thinkncollab.com
+export THINKNCOLLAB_WS_URL=https://app.thinkncollab.com
+export THINKNCOLLAB_AUTO_CONNECT=true
+```
+
+---
+
+## License
+
+MIT © ThinkNCollab

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "thinkncollab-shell",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "ThinkNCollab Custom Shell with WebSocket collaboration",
   "main": "src/core/shell.js",
   "bin": {

package/src/commands/auth/login.js

@@ -1,74 +1,74 @@
-const chalk = require('chalk');
-const fs = require('fs-extra');
-const path = require('path');
+/**
+ * commands/auth/login.js
+ */
+
+const chalk    = require('chalk');
+const inquirer = require('inquirer');
 
 module.exports = {
-    name: 'login',
-    description: 'Login to ThinkNCollab',
-    aliases: ['signin'],
+    name:         'login',
+    description:  'Login to ThinkNCollab',
+    aliases:      ['signin'],
     requiresAuth: false,
 
     async execute(args, shell) {
-        let email, password;
-
-        try {
-            if (args.length === 0) {
-                const { input, password: pwdFn } = require('@inquirer/prompts');
-                email    = await input({ message: 'Email:' });
-                password = await pwdFn({ message: 'Password:', mask: '*' });
-
-            } else if (args.length >= 2) {
-                email    = args[0];
-                password = args[1];
-            } else {
-                console.log(chalk.red('❌ Usage: login <email> <password>'));
-                console.log(chalk.dim('   or:  login (interactive)'));
-                return;
-            }
-
-            if (!email || !password) {
-                console.log(chalk.red('❌ Email and password required'));
-                return;
-            }
+        // Already logged in?
+        if (shell.api.isAuthenticated()) {
+            const u = shell.api.getUser();
+            console.log(chalk.green(`✅ Already logged in as ${u.name} (${u.email})`));
+            console.log(chalk.dim('   Run "logout" first to switch accounts.'));
+            return;
+        }
 
-            console.log(chalk.cyan('🔐 Logging in...'));
+        // Collect credentials
+        let email    = args[0];
+        let password = args[1];
+
+        if (!email || !password) {
+            const answers = await inquirer.prompt([
+                !email    && { type: 'input',    name: 'email',    message: 'Email:',    validate: v => v.includes('@') || 'Enter a valid email' },
+                !password && { type: 'password', name: 'password', message: 'Password:', mask: '*', validate: v => v.length >= 1 || 'Password required' },
+            ].filter(Boolean));
+            email    = email    || answers.email;
+            password = password || answers.password;
+        }
 
-            if (!shell.api) { console.log(chalk.red('❌ API not initialized')); return; }
+        console.log(chalk.blue('🔐 Logging in...'));
 
+        try {
             const result = await shell.api.login(email, password);
 
-            await fs.writeJson(path.join(shell.config.configDir, 'session.json'), {
-                user:      result.user,
-                token:     result.token,
-                timestamp: new Date().toISOString()
-            });
-
-            console.log(chalk.green(`✅ Welcome, ${result.user.name || result.user.email}!`));
-
-            // Auto-connect to WebSocket + join personal notification room
-            try {
-                const token  = result.token;
-                const userId = result.user._id ;
-                const name   = result.user.name || result.user.email;
-
-                // Set user in websocket manager
-                shell.ws._token = token;
-                shell.ws.setUser({ userId, name, userType: 'User' }, token);
-
-                // Connect to backend
-                await shell.ws.connect(token);
-
-                // Join personal notification room (for task assignments etc.)
-                shell.ws.joinUserRoom(userId);
-
-                console.log(chalk.green('🔌 Connected to ThinkNCollab server'));
-            } catch (wsErr) {
-                console.log(chalk.yellow(`⚠️  Could not connect to server: ${wsErr.message}`));
+            // result.user is already normalised by api-client.getUser()
+            // shape: { _id, userId, email, name, userType }
+            const user = result.user;
+
+            // ★ Tell the WebSocket manager who the user is + pass the token
+            // This must happen BEFORE any join attempt
+            shell.ws.setUser(user, result.token);
+
+            // Connect WebSocket if not already connected
+            if (!shell.ws.isConnected()) {
+                try {
+                    await shell.ws.connect(result.token);
+                    console.log(chalk.dim('   🔌 Connected to ThinkNCollab server'));
+                } catch (wsErr) {
+                    // Non-fatal — user can still use REST commands
+                    console.log(chalk.yellow(`   ⚠️  WebSocket unavailable: ${wsErr.message}`));
+                }
+            } else {
+                // Already connected — re-announce with new user identity
+                shell.ws._announceUser?.();
             }
 
+            console.log(chalk.green(`✅ Welcome, ${user.name}!`));
+            console.log(chalk.dim(`   Logged in as ${user.email}`));
+
         } catch (err) {
-            if (err.name === 'ExitPromptError' || err.message?.includes('force closed')) {
-                console.log(chalk.yellow('⚠️  Cancelled'));
+            if (err.message.includes('401') || err.message.toLowerCase().includes('invalid') ||
+                err.message.toLowerCase().includes('unauthorized')) {
+                console.log(chalk.red('❌ Invalid email or password'));
+            } else if (err.message.includes('connect') || err.message.includes('ECONNREFUSED')) {
+                console.log(chalk.red(`❌ Cannot reach server — is it running?`));
             } else {
                 console.log(chalk.red(`❌ Login failed: ${err.message}`));
             }

package/src/commands/auth/register.js

@@ -0,0 +1,52 @@
+/**
+ * src/commands/auth/register.js
+ * Register new account — opens browser with pre-auth session
+ */
+
+const chalk = require('chalk');
+const { exec } = require('child_process');
+
+module.exports = {
+    name: 'register',
+    description: 'Create a new ThinkNCollab account',
+    aliases: ['signup', 'reg'],
+    requiresAuth: false,
+
+    async execute(args, shell) {
+        try {
+            console.log(chalk.cyan('🌐 Opening registration in browser...'));
+
+            const baseUrl = shell.api.apiUrl || 'http://localhost:3001';
+
+            // Generate a CLI source token so backend knows it came from terminal
+            const crypto  = require('crypto');
+            const cliRef  = crypto.randomBytes(8).toString('hex');
+
+            const url = `${baseUrl}/register?ref=cli&cliRef=${cliRef}`;
+
+            // Open browser cross-platform
+            const openCmd = process.platform === 'win32'
+                ? `start "" "${url}"`
+                : process.platform === 'darwin'
+                    ? `open "${url}"`
+                    : `xdg-open "${url}"`;
+
+            exec(openCmd, (err) => {
+                if (err) {
+                    console.log(chalk.yellow('⚠️  Could not open browser automatically.'));
+                    console.log(chalk.dim('   Open this URL manually:'));
+                    console.log(chalk.cyan(`   ${url}`));
+                }
+            });
+
+            console.log(chalk.green(`✅ Registration page opened!`));
+            console.log(chalk.dim(`   URL: ${url}`));
+            console.log('');
+            console.log(chalk.dim('   After registering, come back and run:'));
+            console.log(chalk.cyan('   login'));
+
+        } catch (err) {
+            console.log(chalk.red(`❌ Error: ${err.message}`));
+        }
+    }
+};