skopix 2.0.10 → 2.0.12

package/README.md

@@ -0,0 +1,126 @@
+# Skopix
+
+Record tests by using your app. Replay them anywhere.
+
+**[skopix.ayteelabs.com](https://skopix.ayteelabs.com)**
+
+---
+
+## Install
+
+```bash
+npm install -g skopix
+npx playwright install chromium
+```
+
+---
+
+## Quick Start
+
+### Solo mode
+```bash
+skopix dashboard
+```
+Open `http://localhost:9000` and start recording.
+
+### Team mode (one command)
+Add to `~/.skopix.env` once:
+```
+SKOPIX_SECRET_KEY=your-secret
+SKOPIX_AGENT_EMAIL=your@email.com
+SKOPIX_AGENT_PASSWORD=yourpassword
+```
+Then:
+```bash
+skopix start
+```
+Starts the dashboard + agent in one command. Teammates connect via `http://YOUR-IP:9000`.
+
+### Teammates — connect as agent
+```bash
+skopix agent --server http://HOST-IP:9000 --key "your-secret"
+```
+
+---
+
+## Configure AI
+
+```bash
+skopix init
+```
+Choose Gemini, OpenAI, or Ollama (local — no API key needed).
+
+Or set manually in `~/.skopix.env`:
+```
+SKOPIX_PROVIDER=gemini
+GEMINI_API_KEY=your-key
+```
+
+---
+
+## All Commands
+
+| Command | Description |
+|---|---|
+| `skopix start` | Start dashboard + agent (team mode) |
+| `skopix dashboard` | Start dashboard (solo mode) |
+| `skopix dashboard --team --host 0.0.0.0` | Start dashboard in team mode |
+| `skopix agent --server URL --key SECRET` | Connect as agent to a shared server |
+| `skopix init` | Configure AI provider and API keys |
+| `skopix config --set KEY=value` | Set a config value |
+| `skopix config --list` | List all config values |
+
+---
+
+## Data & Backup
+
+All data lives in `~/.skopix/` — tests, suites, sessions, credentials.
+
+Backup:
+```bash
+node skopix-backup.js
+```
+Restore:
+```bash
+node skopix-restore.js
+```
+Download backup scripts from this repo.
+
+---
+
+## Remote Access
+
+Expose your dashboard to remote teammates using [Portix](https://portix.dev):
+```bash
+portix 9000 --name skopix
+```
+
+---
+
+## Export to Playwright
+
+Every recorded test generates a `.spec.js` / `.spec.ts` file. Download it from the test editor and run it anywhere with:
+```bash
+npx playwright test
+```
+No Skopix needed to run exported tests.
+
+---
+
+## Environment Variables
+
+| Variable | Description |
+|---|---|
+| `SKOPIX_SECRET_KEY` | Required for team mode |
+| `SKOPIX_PROVIDER` | AI provider: `gemini`, `openai`, `ollama` |
+| `GEMINI_API_KEY` | Google Gemini API key |
+| `OPENAI_API_KEY` | OpenAI API key |
+| `OLLAMA_MODEL` | Ollama model name (e.g. `llama3.1`) |
+| `SKOPIX_AGENT_EMAIL` | Auto-agent login email |
+| `SKOPIX_AGENT_PASSWORD` | Auto-agent login password |
+| `BASE_URL` | Override base URL for exported Playwright tests |
+| `TEST_PASSWORD` | Password used in exported Playwright tests |
+
+---
+
+Built by [Aytee Labs](https://ayteelabs.com)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skopix",
-  "version": "2.0.10",
+  "version": "2.0.12",
   "description": "Browser-based QA tool — record tests by using your app, replay them deterministically, generate Playwright code automatically",
   "main": "cli/index.js",
   "bin": {

package/skopix_backup/skopix-backup.command

@@ -0,0 +1,5 @@
+#!/bin/bash
+node ~/Downloads/skopix_backup/skopix-backup.js
+echo ""
+echo "Press any key to close..."
+read -n 1

package/skopix_backup/skopix-backup.js

@@ -0,0 +1,85 @@
+#!/usr/bin/env node
+// ─────────────────────────────────────────────────────────────────
+//  SKOPIX BACKUP
+//  Works on Mac, Windows, and Linux — no dependencies needed.
+//  Usage: node skopix-backup.js
+// ─────────────────────────────────────────────────────────────────
+import fs from 'fs';
+import path from 'path';
+import os from 'os';
+import { execSync } from 'child_process';
+
+const SKOPIX_DIR = path.join(os.homedir(), '.skopix');
+const TODAY = new Date().toISOString().slice(0, 10);
+const BACKUP_NAME = `skopix-backup-${TODAY}.zip`;
+const DESKTOP = path.join(os.homedir(), 'Desktop');
+const DEST = path.join(DESKTOP, BACKUP_NAME);
+
+const c = {
+  cyan:  (s) => `\x1b[36m${s}\x1b[0m`,
+  green: (s) => `\x1b[32m${s}\x1b[0m`,
+  red:   (s) => `\x1b[31m${s}\x1b[0m`,
+  dim:   (s) => `\x1b[2m${s}\x1b[0m`,
+  bold:  (s) => `\x1b[1m${s}\x1b[0m`,
+};
+
+function countFiles(dir) {
+  let count = 0;
+  for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+    if (entry.isDirectory()) count += countFiles(path.join(dir, entry.name));
+    else count++;
+  }
+  return count;
+}
+
+function formatBytes(bytes) {
+  if (bytes < 1024) return bytes + ' B';
+  if (bytes < 1024 * 1024) return (bytes / 1024).toFixed(1) + ' KB';
+  return (bytes / (1024 * 1024)).toFixed(1) + ' MB';
+}
+
+function dirSize(dir) {
+  let total = 0;
+  for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+    const p = path.join(dir, entry.name);
+    if (entry.isDirectory()) total += dirSize(p);
+    else total += fs.statSync(p).size;
+  }
+  return total;
+}
+
+console.log('');
+console.log(c.cyan(c.bold('  SKOPIX BACKUP')));
+console.log('  ' + c.dim('─'.repeat(50)));
+
+if (!fs.existsSync(SKOPIX_DIR)) {
+  console.log('  ' + c.red('✖') + ' ~/.skopix not found — nothing to back up');
+  process.exit(1);
+}
+
+const fileCount = countFiles(SKOPIX_DIR);
+const size = formatBytes(dirSize(SKOPIX_DIR));
+console.log('  Source : ' + c.cyan(SKOPIX_DIR));
+console.log('  Files  : ' + fileCount + ' files (' + size + ')');
+console.log('  Saving : ' + c.cyan(DEST));
+console.log('');
+
+if (fs.existsSync(DEST)) fs.unlinkSync(DEST);
+
+try {
+  const isWindows = process.platform === 'win32';
+  if (isWindows) {
+    const ps = `Compress-Archive -Path "${SKOPIX_DIR}\\*" -DestinationPath "${DEST}" -Force`;
+    execSync(`powershell -Command "${ps}"`, { stdio: 'pipe' });
+  } else {
+    execSync(`cd "${os.homedir()}" && zip -r "${DEST}" .skopix`, { stdio: 'pipe' });
+  }
+  console.log('  ' + c.green('✔') + ' Backup saved to:');
+  console.log('  ' + c.cyan(DEST));
+  console.log('');
+  console.log('  ' + c.dim('Restore with: node skopix-restore.js'));
+  console.log('');
+} catch (e) {
+  console.log('  ' + c.red('✖') + ' Backup failed: ' + e.message);
+  process.exit(1);
+}

package/skopix_backup/skopix-restore.command

@@ -0,0 +1,5 @@
+#!/bin/bash
+node ~/Downloads/skopix_backup/skopix-restore.js
+echo ""
+echo "Press any key to close..."
+read -n 1

package/skopix_backup/skopix-restore.js

@@ -0,0 +1,152 @@
+#!/usr/bin/env node
+// ─────────────────────────────────────────────────────────────────
+//  SKOPIX RESTORE
+//  Works on Mac, Windows, and Linux — no dependencies needed.
+//  Usage: node skopix-restore.js
+//     or: node skopix-restore.js /path/to/skopix-backup-2026-05-26.zip
+// ─────────────────────────────────────────────────────────────────
+import fs from 'fs';
+import path from 'path';
+import os from 'os';
+import { execSync } from 'child_process';
+import readline from 'readline';
+
+const SKOPIX_DIR = path.join(os.homedir(), '.skopix');
+
+const c = {
+  cyan:   (s) => `\x1b[36m${s}\x1b[0m`,
+  green:  (s) => `\x1b[32m${s}\x1b[0m`,
+  yellow: (s) => `\x1b[33m${s}\x1b[0m`,
+  red:    (s) => `\x1b[31m${s}\x1b[0m`,
+  dim:    (s) => `\x1b[2m${s}\x1b[0m`,
+  bold:   (s) => `\x1b[1m${s}\x1b[0m`,
+};
+
+function ask(question) {
+  return new Promise(resolve => {
+    const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+    rl.question('  ' + question, ans => { rl.close(); resolve(ans.trim()); });
+  });
+}
+
+function copyDir(src, dest) {
+  fs.mkdirSync(dest, { recursive: true });
+  for (const entry of fs.readdirSync(src, { withFileTypes: true })) {
+    const s = path.join(src, entry.name);
+    const d = path.join(dest, entry.name);
+    if (entry.isDirectory()) copyDir(s, d);
+    else fs.copyFileSync(s, d);
+  }
+}
+
+function countFiles(dir) {
+  let count = 0;
+  for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+    if (entry.isDirectory()) count += countFiles(path.join(dir, entry.name));
+    else count++;
+  }
+  return count;
+}
+
+function findBackups() {
+  const searchDirs = [
+    path.join(os.homedir(), 'Desktop'),
+    path.join(os.homedir(), 'Downloads'),
+    os.homedir(),
+    process.cwd(),
+  ];
+  const found = [];
+  for (const dir of searchDirs) {
+    if (!fs.existsSync(dir)) continue;
+    for (const f of fs.readdirSync(dir)) {
+      if (f.startsWith('skopix-backup') && f.endsWith('.zip')) {
+        found.push(path.join(dir, f));
+      }
+    }
+  }
+  return found;
+}
+
+console.log('');
+console.log(c.cyan(c.bold('  SKOPIX RESTORE')));
+console.log('  ' + c.dim('─'.repeat(50)));
+
+// Find backup file
+let src = process.argv[2];
+
+if (!src) {
+  const found = findBackups();
+  if (found.length === 0) {
+    console.log('  ' + c.red('✖') + ' No backup files found on Desktop or Downloads.');
+    console.log('  Run: node skopix-restore.js /path/to/backup.zip');
+    process.exit(1);
+  } else if (found.length === 1) {
+    src = found[0];
+    console.log('  Found: ' + c.cyan(src));
+  } else {
+    console.log('  Found multiple backups:');
+    found.forEach((f, i) => console.log('  ' + (i + 1) + '. ' + f));
+    const choice = await ask('Which one to restore? (1-' + found.length + '): ');
+    const idx = parseInt(choice) - 1;
+    if (isNaN(idx) || idx < 0 || idx >= found.length) {
+      console.log('  ' + c.red('✖') + ' Invalid choice'); process.exit(1);
+    }
+    src = found[idx];
+  }
+}
+
+if (!fs.existsSync(src)) {
+  console.log('  ' + c.red('✖') + ' File not found: ' + src);
+  process.exit(1);
+}
+
+console.log('  Backup : ' + c.cyan(src));
+console.log('');
+
+// Warn about overwrite
+if (fs.existsSync(SKOPIX_DIR)) {
+  const existing = countFiles(SKOPIX_DIR);
+  console.log('  ' + c.yellow('⚠') + '  This will overwrite ~/.skopix (' + existing + ' files)');
+  const confirm = await ask('Continue? (y/N): ');
+  if (confirm.toLowerCase() !== 'y') {
+    console.log('  ' + c.yellow('⚠') + '  Restore cancelled.');
+    process.exit(0);
+  }
+
+  // Auto-backup existing data first
+  const autoBackup = path.join(os.tmpdir(), 'skopix-pre-restore-' + Date.now());
+  copyDir(SKOPIX_DIR, autoBackup);
+  console.log('  ' + c.dim('Auto-backed up existing data to: ' + autoBackup));
+}
+
+console.log('  Restoring...');
+
+try {
+  const tmpDir = path.join(os.tmpdir(), 'skopix-restore-' + Date.now());
+  fs.mkdirSync(tmpDir, { recursive: true });
+
+  const isWindows = process.platform === 'win32';
+  if (isWindows) {
+    const ps = `Expand-Archive -Path "${src}" -DestinationPath "${tmpDir}" -Force`;
+    execSync(`powershell -Command "${ps}"`, { stdio: 'pipe' });
+  } else {
+    execSync(`unzip -o "${src}" -d "${tmpDir}"`, { stdio: 'pipe' });
+  }
+
+  // Find .skopix inside the extracted folder
+  const inner = path.join(tmpDir, '.skopix');
+  const actualSrc = fs.existsSync(inner) ? inner : tmpDir;
+
+  if (fs.existsSync(SKOPIX_DIR)) fs.rmSync(SKOPIX_DIR, { recursive: true, force: true });
+  copyDir(actualSrc, SKOPIX_DIR);
+  fs.rmSync(tmpDir, { recursive: true, force: true });
+
+  const restored = countFiles(SKOPIX_DIR);
+  console.log('');
+  console.log('  ' + c.green('✔') + ' Restored ' + restored + ' files to ' + c.cyan(SKOPIX_DIR));
+  console.log('  ' + c.green('✔') + ' Restart Skopix to see your data');
+  console.log('');
+} catch (e) {
+  console.log('  ' + c.red('✖') + ' Restore failed: ' + e.message);
+  process.exit(1);
+}