codequiry-cli 1.0.0 → 2.0.0

package/README.md

@@ -1,179 +1,74 @@
-# Node.js CLI for Plagiarism Checker API
-
-## Detail
-Command Line Interface (CLI) to interact with the Plagiarism Checker API
-
-## Install
-```
-npm install
-npm install -g .
-```
-
-## Usage
-After installation, you can use the following commands:
-
-1. `auth`: Authenticate your API key
-2. `createCheck`: Create a new plagiarism check
-3. `uploadToCheck`: Upload a file to be checked
-4. `startCheck`: Start a plagiarism check
-5. `retriveCheck`: Retrieve existing checks
-6. `checkStatus`: Check the status of a plagiarism check
-7. `resultOverview`: Get an overview of the check results
-8. `detailedResult`: Get detailed results of a check
-
-## Examples
-Here are detailed examples of how to use each command:
-
-### Authenticate
-```
-codequiry auth
-```
-This will prompt you to enter your API key for authentication.
-If you are not authenticated, you will be prompted to enter your API key:
-```
-Enter your API key:
-```
-Once you are authenticated successfully, it will save to apikey.json file and you can see following.
-```
-Hello, lion!
-Your email is victor19930515@outlook.com.
-? Choose an action:
-❯ Create Check
-  Start Check
-  Upload to Check
-```
-### Create Check
-This will initiate the process of creating a new check and provide you with a check ID.
-```
-codequiry createCheck
-```
-You will be prompted to enter the programming language you want to check and name:
-```
-? Enter the programming language: 13
-? Enter the your name:
-```
-Available languages are:
-```
-"available_languages": [
-        { id: 13, language: 'Java (.java)' },
-        { id: 14, language: 'Python (.py)' },
-        { id: 16, language: 'C (.c/.h)' },
-        { id: 17, language: 'C/C++ (.cc/.c/.h/.cpp/.hpp)' },
-        { id: 18, language: 'C# (.cs)' },
-        { id: 20, language: 'Perl (.pl/.sh)' },
-        { id: 21, language: 'PHP (.php)' },
-        { id: 22, language: 'SQL (.sql)' },
-        { id: 23, language: 'VB (.vb/.bas)' },
-        { id: 24, language: 'XML (.xml)' },
-        { id: 28, language: 'Haskell (.hs/.lhs)' },
-        { id: 29, language: 'Pascal (.pas/.inc)' },
-        { id: 30, language: 'Go (.go)' },
-        { id: 31, language: 'Matlab (.m)' },
-        { id: 32, language: 'Lisp (.el)' },
-        { id: 33, language: 'Ruby (.rb)' },
-        { id: 34, language: 'Assembly (.asm/.s)' },
-        { id: 38, language: 'HTML Javascript (.html/.htm/.xhtml)' },
-        { id: 39, language: 'Javascript (.js/.ts)' },
-        { id: 40, language: 'HTML (.html/.htm/.xhtml)' },
-        { id: 41, language: 'Plain text (.txt)' },
-        { id: 42, language: 'Text file by char (.txt)' },
-        { id: 43, language: 'Swift (.swift)' },
-        { id: 44, language: 'Kotlin (.kt/.kts)' },
-        { id: 45, language: 'Yacc (.y,.yy,.ypp,.yxx)' },
-        { id: 46, language: 'Lex (.l,.ll)' },
-        { id: 47, language: 'Elixir (.ex, .exs)' },
-        { id: 48, language: 'Python Jupyter Notebook (.ipynb)' },
-        { id: 49, language: 'Dart (.dart)' },
-        { id: 50, language: 'Shell (.sh/.bash)' },
-        { id: 51, language: 'Rust (.rs)' },
-        { id: 52, language: 'Scala (.scala)' },
-        { id: 53, language: 'R (.r)' },
-        { id: 54, language: 'Objective-C (.m, .mm)' },
-        { id: 55, language: 'TypeScript (.ts, .tsx)' },
-        { id: 56, language: 'Markdown (.md)' },
-        { id: 57, language: 'Julia (.jl)' },
-        { id: 58, language: 'Groovy (.groovy)' },
-        { id: 59, language: 'Sass/SCSS (.scss, .sass)' },
-        { id: 60, language: 'CoffeeScript (.coffee)' },
-        { id: 61, language: 'Lua (.lua)' },
-        { id: 62, language: 'Erlang (.erl, .hrl)' },
-        { id: 63, language: 'F# (.fs, .fsi, .fsx)' },
-        { id: 64, language: 'Fortran (.f90, .f95)' },
-        { id: 65, language: 'Haxe (.hx)' },
-        { id: 66, language: 'Scheme (.scm, .ss)' },
-        { id: 67, language: 'Tcl (.tcl)' },
-        { id: 68, language: 'Ada (.adb, .ads)' },
-        { id: 69, language: 'COBOL (.cob, .cbl)' },
-        { id: 70, language: 'VHDL (.vhd, .vhdl)' }
-    ]
-```
-
-### Upload to Check
-This will upload files in uploads folder to check.
-**Files in uploads folder must be zip files.**
-```
-codequiry uploadToCheck
-```
-You will be prompted to enter check ID.
-```
-? Enter the check ID:
-```
-
-### Start Check
-This will start check.
-```
-codequiry startCheck
-```
-You will be prompted to enter check ID.
-```
-? Enter the check ID:
-? Select the additional check type: (Use arrow keys)
-❯ webcheck
-  dbcheck
-```
-```
-dbcheck: If you would like to run the database check
-webcheck: If you would like to run the web check
-```
-### Retrive Check
-This will retrive check.
-```
-codequiry retriveCheck
-```
-
-### Get Check Status
-This will get check status.
-```
-codequiry checkStatus
-```
-You will be prompted to enter check ID.
-```
-? Enter the check ID:
-```
-
-### Get Result Overview
-This will get result overview.
-```
-codequiry resultOverview
-```
-You will be prompted to enter check ID.
-```
-? Enter the check ID:
-```
-
-### Get Detailed Result
-This will get detailed result.
-```
-codequiry detailedResult
-```
-You will be prompted to enter check ID and submission ID.
-```
-? Enter the check ID: 95663
-? Enter the submission ID: 220801
-```
-
-## Version
-Current version: 1.0.0
-
-## License
-ISC
+# Codequiry CLI
+
+Source code similarity checker from your terminal. Detect plagiarism across 65+ programming languages.
+
+## Quick Install
+
+**macOS / Linux:**
+```bash
+curl -fsSL https://codequiry.com/install.sh | bash
+```
+
+**Windows (PowerShell):**
+```powershell
+irm https://codequiry.com/install.ps1 | iex
+```
+
+**NPM:**
+```bash
+npm install -g codequiry-cli
+```
+
+## Usage
+
+```bash
+# Authenticate
+codequiry auth
+
+# Scan a folder (does everything in one command)
+codequiry scan ./submissions
+
+# Interactive mode
+codequiry
+```
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `codequiry` | Interactive TUI mode |
+| `codequiry scan [path]` | Full scan: zip, upload, start, poll, results |
+| `codequiry auth` | Set your API key |
+| `codequiry checks` | List all checks |
+| `codequiry create` | Create a new check |
+| `codequiry upload [path]` | Upload files to a check |
+| `codequiry start` | Start a check |
+| `codequiry status` | Check progress |
+| `codequiry results` | View results |
+| `codequiry account` | Account info & quota |
+| `codequiry delete` | Delete a check |
+
+## CI/CD
+
+```bash
+# JSON output for pipelines
+codequiry scan ./src --output json
+
+# Fail if similarity exceeds threshold
+codequiry scan ./src --threshold 70
+
+# Auth via environment variable
+export CODEQUIRY_API_KEY=your-key-here
+codequiry scan ./src --output json
+```
+
+## Requirements
+
+- Node.js 18+
+- API key from [codequiry.com](https://codequiry.com) (Grow or Advanced plan)
+
+## Links
+
+- [Codequiry](https://codequiry.com)
+- [API Documentation](https://codequiry.com/usage/docs)
+- [Get API Key](https://codequiry.com/dashboard)

package/bin/codequiry.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+'use strict';
+
+require('../src/index.js');

package/package.json

@@ -1,26 +1,39 @@
-{
-  "name": "codequiry-cli",
-  "version": "1.0.0",
-  "description": "Command Line Interface (CLI) to interact with the Code Plagiarism Checker API",
-  "main": "index.js",
-  "bin": {
-    "codequiry": "src/index.js"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "axios": "^1.7.2",
-    "chalk": "^5.3.0",
-    "commander": "^12.1.0",
-    "dotenv": "^16.4.5",
-    "form-data": "^4.0.0",
-    "fs": "^0.0.1-security",
-    "fs-extra": "^11.2.0",
-    "inquirer": "^10.1.2"
-  },
-  "type": "module"
-}
+{
+  "name": "codequiry-cli",
+  "version": "2.0.0",
+  "description": "Codequiry CLI - Source code similarity checker",
+  "main": "src/index.js",
+  "bin": {
+    "codequiry": "./bin/codequiry.js"
+  },
+  "scripts": {
+    "start": "node bin/codequiry.js",
+    "test": "echo \"No tests yet\""
+  },
+  "keywords": [
+    "codequiry",
+    "plagiarism",
+    "code-similarity",
+    "cli"
+  ],
+  "author": "Codequiry",
+  "license": "MIT",
+  "dependencies": {
+    "commander": "^12.0.0",
+    "inquirer": "^8.2.6",
+    "chalk": "^4.1.2",
+    "ora": "^5.4.1",
+    "cli-table3": "^0.6.0",
+    "cli-progress": "^3.12.0",
+    "axios": "^1.6.0",
+    "form-data": "^4.0.0",
+    "archiver": "^6.0.0",
+    "open": "^8.4.2",
+    "figlet": "^1.7.0",
+    "boxen": "^5.1.2",
+    "gradient-string": "^2.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/src/api/client.js

@@ -0,0 +1,35 @@
+'use strict';
+
+const axios = require('axios');
+const { getApiKey } = require('../utils/config');
+const { handleApiError } = require('../utils/errors');
+
+const BASE_URL = 'https://codequiry.com/api/v1';
+
+function createClient() {
+  const apiKey = getApiKey();
+  if (!apiKey) {
+    throw new Error('Not authenticated. Run `codequiry auth` to set your API key.');
+  }
+
+  const client = axios.create({
+    baseURL: BASE_URL,
+    headers: {
+      apikey: apiKey,
+      Accept: 'application/json',
+    },
+    timeout: 120000,
+  });
+
+  client.interceptors.response.use(
+    (response) => response,
+    (error) => {
+      handleApiError(error);
+      return Promise.reject(error);
+    }
+  );
+
+  return client;
+}
+
+module.exports = { createClient, BASE_URL };

package/src/api/endpoints.js

@@ -0,0 +1,148 @@
+'use strict';
+
+const FormData = require('form-data');
+const fs = require('fs');
+const { createClient } = require('./client');
+
+async function validateKey(apiKey) {
+  const axios = require('axios');
+  const res = await axios.post(
+    'https://codequiry.com/api/v1/auth/validate',
+    {},
+    { headers: { apikey: apiKey, Accept: 'application/json' } }
+  );
+  return res.data;
+}
+
+async function getAccount() {
+  const client = createClient();
+  const res = await client.get('/account');
+  return res.data;
+}
+
+async function getLanguages() {
+  const client = createClient();
+  const res = await client.get('/languages');
+  return res.data;
+}
+
+async function getTestTypes() {
+  const client = createClient();
+  const res = await client.get('/test-types');
+  return res.data;
+}
+
+async function listChecks() {
+  const client = createClient();
+  const res = await client.get('/checks');
+  return res.data;
+}
+
+async function createCheck(name, languageId, testType) {
+  const client = createClient();
+  const res = await client.post('/check/create', {
+    name,
+    language: languageId,
+    test_type: testType,
+  });
+  return res.data;
+}
+
+async function uploadZip(checkId, filePath) {
+  const client = createClient();
+  const form = new FormData();
+  form.append('check_id', String(checkId));
+  form.append('file', fs.createReadStream(filePath));
+
+  const res = await client.post('/check/upload', form, {
+    headers: {
+      ...form.getHeaders(),
+    },
+    maxContentLength: Infinity,
+    maxBodyLength: Infinity,
+  });
+  return res.data;
+}
+
+async function uploadBatch(checkId, filePaths) {
+  const client = createClient();
+  const form = new FormData();
+  form.append('check_id', String(checkId));
+  filePaths.forEach((fp) => {
+    form.append('files[]', fs.createReadStream(fp));
+  });
+
+  const res = await client.post('/check/upload-batch', form, {
+    headers: {
+      ...form.getHeaders(),
+    },
+    maxContentLength: Infinity,
+    maxBodyLength: Infinity,
+  });
+  return res.data;
+}
+
+async function startCheck(checkId, webcheck = 0, dbcheck = 0, testType) {
+  const client = createClient();
+  const body = { check_id: checkId, webcheck, dbcheck };
+  if (testType) body.test_type = testType;
+  const res = await client.post('/check/start', body);
+  return res.data;
+}
+
+async function getCheckStatus(checkId) {
+  const client = createClient();
+  const res = await client.get(`/checks/${checkId}/status`);
+  return res.data;
+}
+
+async function getOverview(checkId) {
+  const client = createClient();
+  const res = await client.post('/check/overview', { check_id: checkId });
+  return res.data;
+}
+
+async function getResults(checkId, submissionId) {
+  const client = createClient();
+  const res = await client.post('/check/results', {
+    check_id: checkId,
+    submission_id: submissionId,
+  });
+  return res.data;
+}
+
+async function getSummary(checkId) {
+  const client = createClient();
+  const res = await client.get(`/checks/${checkId}/summary`);
+  return res.data;
+}
+
+async function deleteCheck(checkId) {
+  const client = createClient();
+  const res = await client.delete(`/checks/${checkId}`);
+  return res.data;
+}
+
+async function getAIResults(checkId) {
+  const client = createClient();
+  const res = await client.get(`/checks/${checkId}/ai-results`);
+  return res.data;
+}
+
+module.exports = {
+  validateKey,
+  getAccount,
+  getLanguages,
+  getTestTypes,
+  listChecks,
+  createCheck,
+  uploadZip,
+  uploadBatch,
+  startCheck,
+  getCheckStatus,
+  getOverview,
+  getResults,
+  getSummary,
+  deleteCheck,
+  getAIResults,
+};

package/src/commands/account.js

@@ -0,0 +1,55 @@
+'use strict';
+
+const chalk = require('chalk');
+const boxen = require('boxen');
+const ora = require('ora');
+const { requireAuth } = require('../utils/errors');
+const { getAccount } = require('../api/endpoints');
+
+async function accountCommand() {
+  requireAuth();
+
+  const spinner = ora('Fetching account info...').start();
+
+  try {
+    const account = await getAccount();
+    spinner.stop();
+
+    const user = account.user || account;
+    const plan = user.plan_name || user.plan || 'Free';
+    const checksUsed = user.checks_used ?? user.procheck_used ?? 0;
+    const checksLimit = user.checks_limit ?? user.procheck_limit ?? 0;
+    const quotaPct = checksLimit > 0 ? Math.round((checksUsed / checksLimit) * 100) : 0;
+    const barLen = 20;
+    const filled = Math.round((quotaPct / 100) * barLen);
+    const quotaBar = chalk.green('█'.repeat(filled)) + chalk.dim('░'.repeat(barLen - filled));
+
+    const content = [
+      chalk.bold('Account'),
+      '',
+      `${chalk.dim('Name:')}    ${user.name || user.email || 'N/A'}`,
+      `${chalk.dim('Email:')}   ${user.email || 'N/A'}`,
+      `${chalk.dim('Plan:')}    ${chalk.cyan(plan)}`,
+      '',
+      chalk.bold('Usage'),
+      '',
+      `${chalk.dim('Checks:')}  ${checksUsed} / ${checksLimit}`,
+      `          ${quotaBar} ${quotaPct}%`,
+    ].join('\n');
+
+    console.log(
+      '\n' +
+        boxen(content, {
+          padding: 1,
+          margin: 1,
+          borderStyle: 'round',
+          borderColor: 'cyan',
+        }) +
+        '\n'
+    );
+  } catch (error) {
+    spinner.fail('Failed to fetch account info.');
+  }
+}
+
+module.exports = accountCommand;

package/src/commands/auth.js

@@ -0,0 +1,56 @@
+'use strict';
+
+const chalk = require('chalk');
+const inquirer = require('inquirer');
+const ora = require('ora');
+const { getApiKey, setApiKey, clearApiKey, isAuthenticated, CONFIG_FILE } = require('../utils/config');
+const { validateKey } = require('../api/endpoints');
+
+async function authCommand(options) {
+  if (options.logout) {
+    clearApiKey();
+    console.log(chalk.green('\n✔ Logged out successfully.\n'));
+    return;
+  }
+
+  if (options.status) {
+    if (isAuthenticated()) {
+      const key = getApiKey();
+      const masked = key.substring(0, 6) + '...' + key.substring(key.length - 4);
+      console.log(chalk.green('\n✔ Authenticated'));
+      console.log(chalk.dim(`  Key: ${masked}`));
+      console.log(chalk.dim(`  Config: ${CONFIG_FILE}\n`));
+    } else {
+      console.log(chalk.yellow('\n⚠ Not authenticated.'));
+      console.log(chalk.dim('  Run `codequiry auth` to set your API key.\n'));
+    }
+    return;
+  }
+
+  // Interactive login
+  const { apiKey } = await inquirer.prompt([
+    {
+      type: 'password',
+      name: 'apiKey',
+      message: 'Enter your Codequiry API key:',
+      mask: '*',
+      validate: (input) => (input.length > 0 ? true : 'API key is required'),
+    },
+  ]);
+
+  const spinner = ora('Validating API key...').start();
+
+  try {
+    await validateKey(apiKey);
+    setApiKey(apiKey);
+    spinner.succeed('API key validated and saved!');
+    console.log(chalk.dim(`  Config: ${CONFIG_FILE}\n`));
+  } catch (error) {
+    spinner.fail('Invalid API key.');
+    if (error.response?.status === 401) {
+      console.error(chalk.dim('  Please check your key at https://codequiry.com/dashboard\n'));
+    }
+  }
+}
+
+module.exports = authCommand;

package/src/commands/checks.js

@@ -0,0 +1,22 @@
+'use strict';
+
+const ora = require('ora');
+const { requireAuth } = require('../utils/errors');
+const { listChecks } = require('../api/endpoints');
+const { checksTable } = require('../utils/display');
+
+async function checksCommand() {
+  requireAuth();
+
+  const spinner = ora('Fetching checks...').start();
+
+  try {
+    const data = await listChecks();
+    spinner.stop();
+    checksTable(data);
+  } catch (error) {
+    spinner.fail('Failed to fetch checks.');
+  }
+}
+
+module.exports = checksCommand;