codequiry-cli 1.0.0 → 2.0.1

package/src/index.js

@@ -1,51 +1,132 @@
-#!/usr/bin/env node
-
-import { program } from 'commander';
-import { authenticate } from './auth.js';
-import { createCheck, uploadToCheck, startCheck, retriveCheck, checkStatus, resultOverview, detailedResult } from './check.js';
-
-program
-    .version('1.0.0')
-    .description('CLI for Plagiarism Checker API');
-
-program
-    .command('auth')
-    .description('Authenticate API key')
-    .action(authenticate);
-
-program
-    .command('createCheck')
-    .description('Create check')
-    .action(createCheck);
-
-program
-    .command('uploadToCheck')
-    .description('Upload file to check')
-    .action(uploadToCheck);
-
-program
-    .command('startCheck')
-    .description('Start check')
-    .action(startCheck);
-
-program
-    .command('retriveCheck')
-    .description('Retrive checks')
-    .action(retriveCheck);
-
-program
-    .command('checkStatus')
-    .description('Check status')
-    .action(checkStatus);
-
-program
-    .command('resultOverview')
-    .description('Result Overview')
-    .action(resultOverview);
-
-program
-    .command('detailedResult')
-    .description('Detailed Result')
-    .action(detailedResult);
-
-program.parse(process.argv);
+'use strict';
+
+const { Command } = require('commander');
+const program = new Command();
+
+program
+  .name('codequiry')
+  .description('Codequiry CLI - Source Code Similarity Checker')
+  .version('2.0.1');
+
+// Auth command
+program
+  .command('auth')
+  .description('Authenticate with your Codequiry API key')
+  .option('--status', 'Show current auth status')
+  .option('--logout', 'Remove saved API key')
+  .action(async (options) => {
+    const authCommand = require('./commands/auth');
+    await authCommand(options);
+  });
+
+// Account command
+program
+  .command('account')
+  .description('Show account info and usage quota')
+  .action(async () => {
+    const accountCommand = require('./commands/account');
+    await accountCommand();
+  });
+
+// Checks command
+program
+  .command('checks')
+  .description('List all your checks')
+  .action(async () => {
+    const checksCommand = require('./commands/checks');
+    await checksCommand();
+  });
+
+// Create command
+program
+  .command('create')
+  .description('Create a new check')
+  .option('-n, --name <name>', 'Check name')
+  .option('-l, --language <id>', 'Language ID')
+  .option('-t, --test-type <id>', 'Test type ID')
+  .action(async (options) => {
+    const createCommand = require('./commands/create');
+    await createCommand(options);
+  });
+
+// Upload command
+program
+  .command('upload [path]')
+  .description('Upload files or folders to a check')
+  .option('-c, --check-id <id>', 'Check ID')
+  .action(async (inputPath, options) => {
+    const uploadCommand = require('./commands/upload');
+    await uploadCommand(inputPath, options);
+  });
+
+// Start command
+program
+  .command('start')
+  .description('Start a check')
+  .option('-c, --check-id <id>', 'Check ID')
+  .option('--web', 'Enable web check')
+  .option('--db', 'Enable database check')
+  .action(async (options) => {
+    const startCommand = require('./commands/start');
+    await startCommand(options);
+  });
+
+// Status command
+program
+  .command('status')
+  .description('Check the status of a check')
+  .option('-c, --check <id>', 'Check ID')
+  .option('-p, --poll', 'Live poll until complete')
+  .action(async (options) => {
+    const statusCommand = require('./commands/status');
+    await statusCommand(options);
+  });
+
+// Results command
+program
+  .command('results')
+  .description('View check results')
+  .option('-c, --check <id>', 'Check ID')
+  .option('-o, --output <format>', 'Output format (json)')
+  .action(async (options) => {
+    const resultsCommand = require('./commands/results');
+    await resultsCommand(options);
+  });
+
+// Delete command
+program
+  .command('delete')
+  .description('Delete a check')
+  .option('-c, --check <id>', 'Check ID')
+  .option('-f, --force', 'Skip confirmation')
+  .action(async (options) => {
+    const deleteCommand = require('./commands/delete');
+    await deleteCommand(options);
+  });
+
+// Scan command (the killer feature)
+program
+  .command('scan [path]')
+  .description('Full scan: zip → create → upload → start → poll → results')
+  .option('-n, --name <name>', 'Check name')
+  .option('-l, --language <id>', 'Language ID')
+  .option('-t, --test-type <id>', 'Test type ID')
+  .option('--web', 'Enable web check')
+  .option('--db', 'Enable database check')
+  .option('-o, --output <format>', 'Output format (json)')
+  .option('--threshold <percent>', 'Fail if similarity exceeds threshold (for CI)')
+  .action(async (inputPath, options) => {
+    const scanCommand = require('./commands/scan');
+    await scanCommand(inputPath, options);
+  });
+
+// Default: interactive TUI when no args
+if (process.argv.length <= 2) {
+  const { mainMenu } = require('./ui/menu');
+  mainMenu().catch((err) => {
+    console.error(err.message);
+    process.exit(1);
+  });
+} else {
+  program.parse(process.argv);
+}

package/src/ui/menu.js

@@ -0,0 +1,85 @@
+'use strict';
+
+const chalk = require('chalk');
+const inquirer = require('inquirer');
+const { showBanner } = require('../utils/banner');
+const { isAuthenticated } = require('../utils/config');
+
+async function mainMenu() {
+  showBanner();
+
+  if (!isAuthenticated()) {
+    console.log(chalk.yellow('  You need to authenticate first.\n'));
+    const authCommand = require('../commands/auth');
+    await authCommand({});
+    if (!isAuthenticated()) return;
+    console.log('');
+  }
+
+  let running = true;
+
+  while (running) {
+    const { action } = await inquirer.prompt([
+      {
+        type: 'list',
+        name: 'action',
+        message: 'What would you like to do?',
+        choices: [
+          { name: '🔍  Scan - Analyze code similarity', value: 'scan' },
+          { name: '📋  Checks - View all checks', value: 'checks' },
+          { name: '➕  Create - New check', value: 'create' },
+          { name: '📤  Upload - Upload files to a check', value: 'upload' },
+          { name: '▶️   Start - Start a check', value: 'start' },
+          { name: '📊  Status - Check progress', value: 'status' },
+          { name: '📈  Results - View results', value: 'results' },
+          { name: '👤  Account - Account info', value: 'account' },
+          { name: '🔑  Auth - Manage API key', value: 'auth' },
+          new inquirer.Separator(),
+          { name: '🚪  Exit', value: 'exit' },
+        ],
+      },
+    ]);
+
+    console.log('');
+
+    try {
+      switch (action) {
+        case 'scan':
+          await require('../commands/scan')(undefined, {});
+          break;
+        case 'checks':
+          await require('../commands/checks')();
+          break;
+        case 'create':
+          await require('../commands/create')({});
+          break;
+        case 'upload':
+          await require('../commands/upload')(undefined, {});
+          break;
+        case 'start':
+          await require('../commands/start')({});
+          break;
+        case 'status':
+          await require('../commands/status')({ poll: true });
+          break;
+        case 'results':
+          await require('../commands/results')({});
+          break;
+        case 'account':
+          await require('../commands/account')();
+          break;
+        case 'auth':
+          await require('../commands/auth')({});
+          break;
+        case 'exit':
+          running = false;
+          console.log(chalk.dim('  Goodbye!\n'));
+          break;
+      }
+    } catch (error) {
+      console.error(chalk.red('\n  Error: ' + error.message + '\n'));
+    }
+  }
+}
+
+module.exports = { mainMenu };

package/src/ui/prompts.js

@@ -0,0 +1,86 @@
+'use strict';
+
+const inquirer = require('inquirer');
+const ora = require('ora');
+const { listChecks, getLanguages, getTestTypes } = require('../api/endpoints');
+
+async function selectCheck(message = 'Select a check:') {
+  const spinner = ora('Fetching checks...').start();
+  const data = await listChecks();
+  const checks = Array.isArray(data) ? data : data?.checks || [];
+  spinner.stop();
+
+  if (checks.length === 0) {
+    return null;
+  }
+
+  const { checkId } = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'checkId',
+      message,
+      choices: checks.map((c) => ({
+        name: `${c.id} - ${c.name} (${c.language_name || c.language || ''})`,
+        value: c.id,
+      })),
+    },
+  ]);
+
+  return checkId;
+}
+
+async function selectLanguage(message = 'Programming language:') {
+  const spinner = ora('Loading languages...').start();
+  const data = await getLanguages();
+  const languages = Array.isArray(data) ? data : data?.languages || [];
+  spinner.stop();
+
+  const { languageId } = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'languageId',
+      message,
+      choices: languages.map((l) => ({
+        name: l.name || l.language,
+        value: l.id,
+      })),
+    },
+  ]);
+
+  return languageId;
+}
+
+async function selectTestType(message = 'Check engine:') {
+  const spinner = ora('Loading test types...').start();
+  const data = await getTestTypes();
+  const types = Array.isArray(data) ? data : data?.test_types || [];
+  spinner.stop();
+
+  const { testType } = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'testType',
+      message,
+      choices: types.map((t) => ({
+        name: t.name || t.type,
+        value: t.id,
+      })),
+    },
+  ]);
+
+  return testType;
+}
+
+async function confirmAction(message, defaultVal = false) {
+  const { confirmed } = await inquirer.prompt([
+    {
+      type: 'confirm',
+      name: 'confirmed',
+      message,
+      default: defaultVal,
+    },
+  ]);
+  return confirmed;
+}
+
+module.exports = { selectCheck, selectLanguage, selectTestType, confirmAction };

package/src/utils/banner.js

@@ -0,0 +1,20 @@
+'use strict';
+
+const figlet = require('figlet');
+const gradient = require('gradient-string');
+const chalk = require('chalk');
+
+function showBanner() {
+  try {
+    const text = figlet.textSync('Codequiry', {
+      font: 'Standard',
+      horizontalLayout: 'default',
+    });
+    console.log(gradient.vice(text));
+    console.log(chalk.dim('  Source Code Similarity Checker') + '  ' + chalk.dim('v2.0.1\n'));
+  } catch {
+    console.log(gradient.vice('\n  Codequiry CLI v2.0.1\n'));
+  }
+}
+
+module.exports = { showBanner };

package/src/utils/config.js

@@ -0,0 +1,67 @@
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+
+const CONFIG_DIR = path.join(os.homedir(), '.codequiry');
+const CONFIG_FILE = path.join(CONFIG_DIR, 'config.json');
+
+function ensureConfigDir() {
+  if (!fs.existsSync(CONFIG_DIR)) {
+    fs.mkdirSync(CONFIG_DIR, { recursive: true });
+  }
+}
+
+function readConfig() {
+  ensureConfigDir();
+  if (!fs.existsSync(CONFIG_FILE)) {
+    return {};
+  }
+  try {
+    return JSON.parse(fs.readFileSync(CONFIG_FILE, 'utf8'));
+  } catch {
+    return {};
+  }
+}
+
+function writeConfig(config) {
+  ensureConfigDir();
+  fs.writeFileSync(CONFIG_FILE, JSON.stringify(config, null, 2), 'utf8');
+}
+
+function getApiKey() {
+  // Environment variable takes precedence
+  if (process.env.CODEQUIRY_API_KEY) {
+    return process.env.CODEQUIRY_API_KEY;
+  }
+  const config = readConfig();
+  return config.apiKey || null;
+}
+
+function setApiKey(apiKey) {
+  const config = readConfig();
+  config.apiKey = apiKey;
+  writeConfig(config);
+}
+
+function clearApiKey() {
+  const config = readConfig();
+  delete config.apiKey;
+  writeConfig(config);
+}
+
+function isAuthenticated() {
+  return !!getApiKey();
+}
+
+module.exports = {
+  CONFIG_DIR,
+  CONFIG_FILE,
+  readConfig,
+  writeConfig,
+  getApiKey,
+  setApiKey,
+  clearApiKey,
+  isAuthenticated,
+};

package/src/utils/display.js

@@ -0,0 +1,122 @@
+'use strict';
+
+const Table = require('cli-table3');
+const chalk = require('chalk');
+
+function colorScore(score) {
+  const num = parseFloat(score);
+  if (isNaN(num)) return chalk.dim(score);
+  if (num > 70) return chalk.red.bold(num.toFixed(1) + '%');
+  if (num > 30) return chalk.yellow(num.toFixed(1) + '%');
+  return chalk.green(num.toFixed(1) + '%');
+}
+
+function statusColor(status) {
+  const s = String(status).toLowerCase();
+  if (s === 'completed' || s === 'done') return chalk.green(status);
+  if (s === 'checking' || s === 'waiting' || s === 'uploading') return chalk.yellow(status);
+  if (s === 'failed' || s === 'error') return chalk.red(status);
+  return chalk.dim(status);
+}
+
+// API returns array of Assignment objects directly from getChecks
+function checksTable(checks) {
+  const table = new Table({
+    head: [
+      chalk.cyan('ID'),
+      chalk.cyan('Name'),
+      chalk.cyan('Language'),
+      chalk.cyan('Status'),
+      chalk.cyan('Created'),
+    ],
+    style: { head: [], border: ['dim'] },
+  });
+
+  const list = Array.isArray(checks) ? checks : [];
+
+  if (list.length === 0) {
+    console.log(chalk.dim('\n  No checks found.\n'));
+    return;
+  }
+
+  list.forEach((c) => {
+    // Assignment model fields from Laravel
+    const statusName = c.assignmentstatuses?.status || '';
+    table.push([
+      chalk.white(c.id),
+      c.name || '',
+      String(c.language_id || ''),
+      statusColor(statusName),
+      c.created_at ? new Date(c.created_at).toLocaleDateString() : '',
+    ]);
+  });
+
+  console.log('\n' + table.toString() + '\n');
+}
+
+// API overview returns {overviewURL, submissions, bardata}
+// submissions have: id, filename, result1 (score), assignment_id, etc.
+function overviewTable(overview) {
+  const submissions = overview?.submissions || [];
+
+  if (!Array.isArray(submissions) || submissions.length === 0) {
+    console.log(chalk.dim('\n  No results available.\n'));
+    return;
+  }
+
+  const table = new Table({
+    head: [
+      chalk.cyan('ID'),
+      chalk.cyan('Filename'),
+      chalk.cyan('Similarity'),
+    ],
+    style: { head: [], border: ['dim'] },
+  });
+
+  submissions.forEach((s) => {
+    const score = s.result1 || s.total_result || 0;
+    table.push([
+      chalk.white(s.id || ''),
+      s.filename || '',
+      colorScore(score),
+    ]);
+  });
+
+  console.log('\n' + table.toString() + '\n');
+}
+
+// API results returns {submission, avg, max, min, other_matches, related_submissions, related_files}
+function resultsDetailTable(results) {
+  const matches = results?.other_matches || [];
+
+  if (!Array.isArray(matches) || matches.length === 0) {
+    console.log(chalk.dim('\n  No matches found.\n'));
+    return;
+  }
+
+  const table = new Table({
+    head: [
+      chalk.cyan('Matched With'),
+      chalk.cyan('Tokens'),
+      chalk.cyan('Type'),
+    ],
+    style: { head: [], border: ['dim'] },
+  });
+
+  matches.forEach((m) => {
+    table.push([
+      m.filename || m.other_filename || '',
+      String(m.tokens || ''),
+      m.type || '',
+    ]);
+  });
+
+  console.log('\n' + table.toString());
+
+  // Show stats
+  if (results.avg !== undefined) {
+    console.log(chalk.dim(`  Avg: ${results.avg}%  Max: ${results.max}%  Min: ${results.min}%\n`));
+  }
+}
+
+module.exports = { colorScore, statusColor, checksTable, overviewTable, resultsDetailTable };

package/src/utils/errors.js

@@ -0,0 +1,63 @@
+'use strict';
+
+const chalk = require('chalk');
+
+function handleApiError(error) {
+  if (error.response) {
+    const { status, data } = error.response;
+    const message = data?.message || data?.error || 'Unknown error';
+
+    switch (status) {
+      case 401:
+        console.error(chalk.red('\n✖ Authentication failed. Check your API key.'));
+        console.error(chalk.dim('  Run `codequiry auth` to update your key.\n'));
+        break;
+      case 403:
+        console.error(chalk.red('\n✖ Access denied: ' + message));
+        break;
+      case 404:
+        console.error(chalk.red('\n✖ Not found: ' + message));
+        break;
+      case 422:
+        console.error(chalk.red('\n✖ Validation error: ' + message));
+        if (data?.errors) {
+          Object.entries(data.errors).forEach(([field, msgs]) => {
+            const msgList = Array.isArray(msgs) ? msgs : [msgs];
+            msgList.forEach((m) => console.error(chalk.yellow(`  • ${field}: ${m}`)));
+          });
+        }
+        break;
+      case 429:
+        console.error(chalk.red('\n✖ Rate limit exceeded. Please wait and try again.'));
+        break;
+      case 500:
+        console.error(chalk.red('\n✖ Server error. Please try again later.'));
+        break;
+      default:
+        console.error(chalk.red(`\n✖ API error (${status}): ${message}`));
+    }
+  } else if (error.code === 'ECONNREFUSED' || error.code === 'ENOTFOUND') {
+    console.error(chalk.red('\n✖ Could not connect to Codequiry servers.'));
+    console.error(chalk.dim('  Check your internet connection.\n'));
+  } else if (error.code === 'ECONNABORTED' || error.code === 'ETIMEDOUT') {
+    console.error(chalk.red('\n✖ Request timed out. Please try again.'));
+  } else {
+    console.error(chalk.red('\n✖ ' + (error.message || 'An unexpected error occurred.')));
+  }
+}
+
+function exitWithError(message) {
+  console.error(chalk.red('\n✖ ' + message + '\n'));
+  process.exit(1);
+}
+
+function requireAuth() {
+  const { isAuthenticated } = require('../utils/config');
+  if (!isAuthenticated()) {
+    console.error(chalk.red('\n✖ Not authenticated.'));
+    console.error(chalk.dim('  Run `codequiry auth` to set your API key.\n'));
+    process.exit(1);
+  }
+}
+
+module.exports = { handleApiError, exitWithError, requireAuth };

package/src/utils/poller.js

@@ -0,0 +1,56 @@
+'use strict';
+
+const ora = require('ora');
+const chalk = require('chalk');
+const { getCheckStatus } = require('../api/endpoints');
+
+async function pollUntilComplete(checkId, { silent = false } = {}) {
+  const POLL_INTERVAL = 3000;
+  let spinner;
+  let interrupted = false;
+
+  const cleanup = () => {
+    interrupted = true;
+    if (spinner) spinner.stop();
+  };
+
+  process.on('SIGINT', cleanup);
+
+  if (!silent) {
+    spinner = ora('Waiting for check to complete...').start();
+  }
+
+  try {
+    while (!interrupted) {
+      const status = await getCheckStatus(checkId);
+      const statusId = status?.status_id;
+      const progress = status?.progress ?? 0;
+
+      // status_id 4 = Completed
+      if (statusId === 4) {
+        if (spinner) spinner.succeed('Check completed!');
+        return status;
+      }
+
+      // status_id 5 = Error/Failed
+      if (statusId === 5 || statusId === -1) {
+        if (spinner) spinner.fail('Check failed: ' + (status?.status_message || status?.status || ''));
+        return status;
+      }
+
+      // Update progress display
+      if (!silent && spinner) {
+        const statusText = status?.status || 'Processing';
+        const msg = status?.status_message || '';
+        spinner.text = `${statusText}... ${chalk.cyan(progress + '%')}${msg ? chalk.dim(' - ' + msg) : ''}`;
+      }
+
+      await new Promise((resolve) => setTimeout(resolve, POLL_INTERVAL));
+    }
+  } finally {
+    process.removeListener('SIGINT', cleanup);
+    if (spinner) spinner.stop();
+  }
+}
+
+module.exports = { pollUntilComplete };