User Guide
Everything you need to know to get started with Codswallop and build genuine programming skills.
Getting Started
Install the Extension
Open VS Code, go to Extensions (Ctrl+Shift+X), search for "Codswallop", and click Install.
Start Coding
The extension activates automatically. Code as you normally would - Codswallop monitors your patterns in the background.
Take Quizzes
When vibe patterns are detected, a "Take Quiz" prompt appears above your code. Click it to test your understanding.
Joining a Classroom
If your educator has provided a classroom code, follow these steps to join and sync your progress:
Open Command Palette
Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac).
Login
Type Codswallop: Login and press Enter. A browser window will open for authentication.
Join Classroom
Open the Command Palette again and type Codswallop: Join Classroom. Enter the 6-character code from your educator.
Understanding Detection
Codswallop monitors three patterns that may indicate code was added without full comprehension:
Line Spike Detection
Triggers when more than 50 lines per minute are added.
Rapid code additions often suggest copy-paste from AI assistants or external sources.
Complexity Analysis
Triggers when cyclomatic complexity exceeds 20.
Complex branching logic (many if/else, loops, conditions) requires deeper understanding.
Paste Detection
Triggers when more than 10 lines are pasted at once.
Large paste operations bypass the learning process of writing code step by step.
Taking Quizzes
When a vibecheck is triggered, you will see a clickable "Take Quiz" prompt appear above your code (called a CodeLens). Here is what to expect:
- 4 multiple-choice questions generated by Claude AI based on your specific code
- 75% pass threshold - answer 3 out of 4 correctly to pass
- Questions focus on control flow, edge cases, and behaviour - not memorisation
- Immediate feedback after each answer with explanations
- Results sync to dashboard if you have joined a classroom
You can also manually trigger a quiz by running Codswallop: Start Vibecheck from the Command Palette.
Command Reference
Access all commands via the Command Palette (Ctrl+Shift+P / Cmd+Shift+P):
| Command | Description |
|---|---|
| Codswallop: Start Vibecheck | Manually trigger a quiz |
| Codswallop: Show Detections | View all active detections |
| Codswallop: Show Vibe Character | Display the animated companion |
| Codswallop: Login | Authenticate with your account |
| Codswallop: Logout | Sign out of your account |
| Codswallop: Join Classroom | Enter a classroom code |
| Codswallop: Open Dashboard | Open the educator dashboard |
| Codswallop: Show Auth Status | Check authentication state |
| Codswallop: Set Anthropic API Key | Configure personal API key |
| Codswallop: Clear Anthropic API Key | Remove stored API key |
Configuration
Adjust detection thresholds in VS Code Settings (Ctrl+, / Cmd+,):
| Setting | Default | Description |
|---|---|---|
| codswallop.enabled | true | Enable/disable detection |
| codswallop.thresholds.lineSpike | 50 | Lines per minute threshold |
| codswallop.thresholds.complexity | 20 | Cyclomatic complexity threshold |
| codswallop.thresholds.pasteLines | 10 | Pasted lines threshold |
| codswallop.debounceWindow | 60000 | Cooldown (ms) before re-triggering |
For Educators
Educators can create classrooms and monitor student progress through the dashboard:
Access the Dashboard
Visit codswallop-m6n9.vercel.app and sign in. First-time users can register as an educator.
Create a Classroom
Navigate to Classrooms and create a new classroom. You will receive a 6-character join code to share with students.
Monitor Progress
View real-time activity feeds, student leaderboards, vibecheck results, and identify common struggle areas.
Need Help?
Found a bug or have a feature request? We would love to hear from you.
Open an Issue on GitHub