PhishGuard CLI

A Node.js command-line interface for managing the PhishGuard Quiz — a phishing awareness quiz for students.

Installation

npm install -g phishguard-cli

Or run without installing:

npx phishguard-cli

Quick Start

# Point the CLI at your deployed app (one-time setup)
phishguard config set --url https://your-app.vercel.app

# Authenticate as admin
phishguard login

# View dashboard
phishguard stats

Commands

| Command | Description | |---|---| | phishguard login | Authenticate as admin | | phishguard logout | Clear saved credentials | | phishguard stats | Full dashboard — overview, grades, top performers, timeline | | phishguard students | List all student submissions | | phishguard export | Export results to CSV | | phishguard quiz | Take the quiz as a student | | phishguard config | Show current config | | phishguard config set --url <url> | Set API URL |

phishguard students options

phishguard students                     # all students
phishguard students --grade "Grade 10"  # filter by grade
phishguard students --pass              # passed only  (>=60%)
phishguard students --fail              # failed only  (<60%)

phishguard export options

phishguard export                        # saves to phishguard-results-YYYY-MM-DD.csv
phishguard export --output results.csv   # custom output path

Requirements

• Node.js 18 or later
• A running PhishGuard Quiz API (local or deployed on Vercel)

Configuration

Credentials are saved to ~/.config/phishguard/config.json automatically after login.

{
  "apiUrl": "https://your-app.vercel.app",
  "token": "..."
}

License

MIT