Automate Plagiarism Detection From Your Terminal
→ Enter your name: Assignment 1
✓ Check created with ID: 95663
Built for Developers Who Live in the Terminal
While our web interface handles batch uploads beautifully, the CLI is for developers who need automation, CI/CD integration, and scriptable workflows. If you want to embed plagiarism detection into your development pipeline or run checks programmatically, this is your tool.
CI/CD Pipeline Integration
Seamlessly integrate plagiarism checks into GitHub Actions, GitLab CI, Jenkins, or any CI/CD tool. Run checks automatically on every commit or pull request.
Scriptable Workflows
Write custom scripts to automate repetitive checks. Combine with cron jobs for scheduled monitoring or trigger checks based on specific events in your workflow.
Terminal-First Experience
For developers who prefer the command line. No browser needed, works in headless environments, and integrates perfectly with your existing terminal-based workflow.
Local API Key Storage
Authenticate once and the CLI securely stores your API key locally. No need to log in repeatedly—perfect for automated scripts and scheduled jobs.
Headless Environments
Works perfectly on servers, Docker containers, and headless systems where a web browser isn't available. Ideal for automated build servers and production environments.
Repeatable & Consistent
Same commands, same results every time. Perfect for creating reproducible workflows, documentation, and ensuring consistency across your team's processes.
Up & Running in Under 60 Seconds
Works on Windows, Mac, and Linux. Just one command to install, one command to authenticate. No complex setup, no configuration files to edit—just pure simplicity.
# Install dependencies
npm install
# Install globally
npm install -g .
# Verify installation
codequiry --version
# Authenticate with your API key
codequiry auth# Install dependencies
yarn install
# Install globally
yarn global add .
# Verify installation
codequiry --version
# Authenticate with your API key
codequiry auth# Clone the repository
git clone https://github.com/cqchecker/codequiry-cli.git
cd codequiry-cli
# Install dependencies
npm install
# Build the project
npm run build
# Link globally
npm link
# Verify installation
codequiry --versionRequirements
-
Node.js
Version 16.0 or higher -
NPM or Yarn
Package manager -
API Key
From your Codequiry account -
Internet Connection
For API communication
Available Commands
Complete list of commands available in the Codequiry CLI tool for plagiarism detection.
Authentication
Authenticate your API key to access the Codequiry plagiarism detection service.
# Authenticate with API key
codequiry auth
# You will be prompted to enter your API key
# The key is saved to apikey.json for future useCreate Check
Create a new plagiarism check with specified programming language and name.
# Create a new check
codequiry createCheck
# You will be prompted for:
# - Programming language (ID from list)
# - Check name
# Returns a check ID for further operationsUpload to Check
Upload files from the uploads folder to an existing check. The CLI can handle whole folders of ZIP files, making it perfect for batch processing multiple student submissions or project archives.
# Upload files to check
codequiry uploadToCheck
# You will be prompted for:
# - Check ID
# Files in uploads folder must be ZIP files
# Supports entire folders of ZIP archives for batch processing
# Example folder structure:
# uploads/
# ├── student1.zip
# ├── student2.zip
# ├── project1.zip
# └── assignment3.zipStart Check
Start a plagiarism check with web checking or database checking options.
# Start a check
codequiry startCheck
# You will be prompted for:
# - Check ID
# - Check type: webcheck or dbcheck
# webcheck: Run against web sources
# dbcheck: Run against internal databaseRetrieve Check
Retrieve existing checks and their details from your account.
# Retrieve existing checks
codequiry retriveCheck
# Lists all checks with their IDs and statusCheck Status
Check the current status of a plagiarism check.
# Check status of a specific check
codequiry checkStatus
# You will be prompted for:
# - Check ID
# Returns current status (pending, running, completed)Result Overview
Get an overview of check results and similarity scores.
# Get result overview
codequiry resultOverview
# You will be prompted for:
# - Check ID
# Shows similarity scores and basic resultsDetailed Result
Get detailed results for a specific submission within a check.
# Get detailed results
codequiry detailedResult
# You will be prompted for:
# - Check ID
# - Submission ID
# Shows detailed similarity analysisReal-World CLI Use Cases
The CLI shines when you need automation, integration, and programmability. Here's where it makes the biggest difference compared to using our web interface.
Automated GitHub Actions
Run checks on every pull request
A coding bootcamp uses GitHub Classroom for assignments. They integrated the CLI into their GitHub Actions workflow—now every student submission is automatically checked for plagiarism when they open a pull request. No manual intervention required; instructors get notified of potential issues immediately.
# .github/workflows/plagiarism-check.yml
name: Plagiarism Check
on: [pull_request]
jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install CLI
run: npm install -g codequiry-cli
- name: Authenticate
run: codequiry auth
env:
CODEQUIRY_API_KEY: {{ secrets.CODEQUIRY_KEY }}
- name: Run Check
run: codequiry createCheck && codequiry startCheckScheduled Monitoring
Cron jobs & automated checks
An online learning platform runs nightly cron jobs to check new submissions against their entire historical database. The CLI handles authentication automatically and emails reports to instructors—zero manual work required. Perfect for monitoring large-scale courses with thousands of students.
Scheduled Checks
Run daily, weekly, or on-demand
Server-Side Processing
No browser required—runs headless
Automatic Notifications
Email alerts when issues detected
Historical Comparisons
Check against past semesters
Custom Scripts
Integrate with your own tools
Continuous Monitoring
Always-on plagiarism detection
Complete Command Reference
Explore all available commands and options for the Codequiry CLI tool.
auth - Authenticate with API key
Authenticate your API key to access the Codequiry plagiarism detection service.
codequiry authDescription:
- Prompts you to enter your API key
- Saves the key to apikey.json for future use
- Displays user information upon successful authentication
- Required before using other commands
createCheck - Create a new plagiarism check
Create a new plagiarism check with specified programming language and name.
codequiry createCheckPrompts:
- Programming language: Enter the language ID from the available list
- Name: Enter a name for your check
Returns:
- Check ID for further operations
uploadToCheck - Upload files to existing check
Upload files from the uploads folder to an existing check. Files must be ZIP archives.
codequiry uploadToCheckRequirements:
- Files must be placed in the
uploadsfolder - Files must be ZIP archives
- Valid check ID must exist
Prompts:
- Check ID: Enter the ID of the check to upload files to
startCheck - Start a plagiarism check
Start a plagiarism check with web checking or database checking options.
codequiry startCheckPrompts:
- Check ID: Enter the ID of the check to start
- Check type: Choose between:
webcheck- Run against web sourcesdbcheck- Run against internal database
51+ Programming Languages Supported
The Codequiry CLI supports a wide range of programming languages for comprehensive plagiarism detection.
Available Programming Languages
Popular Languages
Modern Languages
And many more! Including Haskell, Pascal, Matlab, Lisp, Ruby, Assembly, HTML, Markdown, Shell scripts, and specialized formats like Jupyter Notebooks (.ipynb).
Automate Your Plagiarism Detection Workflow
Need CI/CD integration, scheduled checks, or headless automation? The CLI is your tool. Free forever. Open source. No credit card required. Perfect for developers who want programmatic control over plagiarism detection.