crackquiz

CLI tool for CrackQuiz - open quiz files in your browser with AI assistant integration.

Installation

Method 1: Homebrew (macOS/Linux)

brew tap anouar-bm/crackquiz
brew install crackquiz

Method 2: NPM (Cross-platform)

npm install -g crackquiz

Usage

Open a Quiz

Open a quiz JSON file in your browser:

crackquiz open quiz.json

Options:

• --locale <locale> - Set quiz language (en, fr, ar) - default: en
• --time <minutes> - Set time limit in minutes
• --dry-run - Preview without opening browser
• --verbose - Show detailed output

Validate a Quiz

Validate quiz JSON schema:

crackquiz validate quiz.json

Initialize AI Assistant Integration

Install the opening-quiz skill to your AI coding assistants:

Interactive Mode (Default)

Choose which AI assistants to install to:

crackquiz init

This will:

1. Auto-detect existing AI assistant folders (.claude, .cursor, .windsurf, etc.)
2. Show version status with color coding:
   • ✓ Green = up-to-date
   • ⚠️ Yellow = outdated (shows version difference)
   • ○ Gray = not installed
3. Ask once for all assistants (no repetitive prompts)
4. Offer to create folders for assistants that aren't set up yet
5. Install with smart update handling

Auto Mode

Automatically install/update all detected assistants without prompts:

crackquiz init --auto

Perfect for CI/CD or quick setup.

Update Skill Files

Update all outdated installations:

crackquiz update

Automatically detects and updates only the assistants with outdated skill files.

Update CLI Tool

Update the CLI tool itself (auto-detects Homebrew or NPM):

crackquiz update-cli

Onboarding

Start an interactive demo to learn how to use the tool:

crackquiz onboard

Supported AI Assistants

• Claude Code - .claude/skills
• OpenAI Codex - .codex/skills
• Cursor - .cursor/skills
• Windsurf - .windsurf/skills
• Google Antigravity - .agent/skills
• GitHub Copilot - .github/skills
• Kilo - ~/.kilocode/skills (global)

Quiz JSON Schema

See the SCHEMA.md for complete quiz format specification.

Quick Example

{
  "version": "1.0",
  "metadata": {
    "title": "JavaScript Basics",
    "description": "Test your JavaScript knowledge"
  },
  "questions": [
    {
      "id": "q1",
      "type": "single",
      "question": "What is the output of `typeof null`?",
      "options": [
        { "id": "a", "text": "null" },
        { "id": "b", "text": "object" },
        { "id": "c", "text": "undefined" }
      ],
      "correctAnswer": "b"
    }
  ]
}

Features

• 🔒 Privacy-first: Small quizzes stay in browser (URL compression)
• ☁️ Large quiz support: Automatic upload to temporary storage (5-min TTL)
• ✅ Schema validation: Comprehensive quiz format checking
• 🤖 AI integration: Works seamlessly with Claude Code
• 🌍 Multi-language: Support for English, French, and Arabic

Publishing

For information about publishing this package (public npm, GitHub Packages, private npm, or local installation), see PUBLISH_OPTIONS.md.

Current configuration: Public npm package from private repository.

License

ISC