Dashboard
The dashboard provides a web interface to manage your scans, API keys, settings, and subscription.
Overview
The dashboard is available at /dashboard for authenticated users. It provides the same functionality as the API but with a visual interface.
| Page | Description |
|---|---|
| /dashboard | Account info and subscription management |
Account Management
View your account details including email, name, and verification status at /dashboard.
Account Details
- Email - Your registered email address
- Name - Display name (optional)
- Status - Email verification status (Verified/Unverified)
Subscription & Billing
Manage your subscription plan and view billing information at /dashboard.
Available Plans
| Plan | Price | Features |
|---|---|---|
| Free | $0/mo | 5 basic scans/day (30/month), Basic scan level |
| Plus | $19/mo | 50 basic + 100 standard scans/day (500 basic + 1000 standard/month), Basic + Standard levels, API key included |
| Premium | $49/mo | Unlimited basic & standard scans, 50 deep scans/day (500/month), All levels, Priority support |
Scans Available
Shows the number of Standard/Deep scans remaining in your current billing cycle. Basic scans are always free and unlimited.
Upgrade Plan
Click the "Upgrade Plan" button to manage your subscription. You'll be redirected to the billing portal where you can update your payment method and plan.
Creating Scans
Create a new repository scan at /dashboard/new-scan.
Scan Form
- Repository- Enter in format "owner/repo" (e.g., facebook/react)
- Scan Level - Choose Basic, Standard, or Deep
- Webhook URL - Optional endpoint for completion notifications
Real-Time Progress
After submitting, you'll see real-time progress updates showing the current scan stage and completion percentage.
Managing Scans
View and manage your scans at /dashboard/scans.
Scan List
View all your scans with pagination. Each scan shows repository, level, status, and creation date.
Filtering
Filter scans by status or level using the filter controls:
- Status - in_progress, completed, failed, cancelled
- Level - basic, standard, deep
Scan Details
Click on any scan to view detailed results including metadata, heuristics, and additional analysis fields based on scan level.
Actions
- View - See full scan results
- Download PDF - Export results as PDF
- Cancel - Cancel an in-progress scan
- Delete - Remove a scan and its results
API Key Management
Generate and manage API keys at /dashboard/api-key.
Using API Keys
Include your API key in requests using the X-API-Key header or apiKey query parameter.
curl -X GET "http://repo-cat.futoro.co.uk/api/v1/scan?repo=owner/repo&level=standard" \ -H "X-API-Key: your-api-key-here"or
curl -X GET "http://repo-cat.futoro.co.uk/api/v1/scan?repo=owner/repo&level=standard&apiKey=your-api-key-here"
Key Generation
Click "Generate New Key" to create an API key. Make sure to copy it immediately as it won't be shown again.
User Settings
Configure notifications and webhooks at /dashboard/settings.
Notifications
- Email - Update your notification email address
- Enable Notifications - Toggle email notifications on/off
Webhooks
Configure a webhook URL to receive HTTP POST requests when scan events occur. See the Webhooks documentation for full details.
- Webhook URL - Endpoint to receive notifications
- Enabled - Toggle webhooks on/off
- Event Types - Select which events trigger webhooks