Documentation

Dashboard Guide

The TK-TIS web dashboard provides a visual interface for managing projects, viewing test results, monitoring performance trends, and configuring your team and notifications.

Access the dashboard at tk-tis.pages.dev/dashboard/

Login and Registration

Creating an account is quick and free:

  1. Navigate to the dashboard
  2. Click Sign Up and enter your email and password
  3. Verify your email address via the confirmation link
  4. Log in with your credentials
Note

The Free plan includes 1 project. Upgrade to Starter, Pro, or Enterprise for additional projects and features. See Pricing for details.

Overview Page

The dashboard overview provides a high-level view of all your projects:

  • Health Status — Green/yellow/red indicator for each project based on latest scan results
  • Recent Activity — Timeline of recent scans, security checks, and performance measurements
  • Score Trends — Charts showing health score, security grade, and performance score over time
  • Alerts — Active alerts and recent notifications

Managing Projects

Adding a Project

  1. Click Add Project from the overview page
  2. Enter the project name and primary URL
  3. Optionally configure additional routes to monitor
  4. Select which tools to run (tk-scan, tk-guard, tk-pulse)
  5. Set monitoring frequency (manual, hourly, daily, weekly)
  6. Click Create Project

Project Settings

Each project has configurable settings:

  • URL and Routes — Primary URL and additional routes to scan
  • Thresholds — Custom pass/fail thresholds for each tool
  • Schedule — Automated monitoring frequency
  • Notifications — Alert channels for this project (email, Slack, webhook)
  • Deploy Hooks — Trigger scans automatically after deployments

Deleting a Project

Navigate to Project Settings and scroll to the bottom. Click Delete Project and confirm. This removes all historical data for the project.

Viewing Test Results

Click on any project to see its detailed results page:

Scan Results (tk-scan)

  • Overall health score with pass/fail status
  • Route-by-route breakdown with status codes, response times, and body sizes
  • Security headers analysis with present/missing indicators
  • CORS, SEO, and stale URL check results
  • Historical score chart showing trends over time

Security Results (tk-guard)

  • Security grade (A through F) and risk score
  • Findings grouped by severity (Critical, High, Medium, Low, Info)
  • Detailed description and remediation advice for each finding
  • Evidence and reproduction details where applicable
  • Historical grade chart

Performance Results (tk-pulse)

  • Speed score and grade
  • TTFB, load time, response size, and API latency breakdown
  • Percentile charts (p50, p90, p99) for repeated measurements
  • Performance trends over days, weeks, and months

Performance Monitoring

When automated monitoring is enabled, the dashboard tracks performance metrics over time:

  • Uptime — Percentage uptime over 24h, 7d, 30d, and 90d windows
  • Response Time — Average, median, and P99 response times
  • Size Tracking — Response size changes that might indicate build issues
  • Incident Log — Timeline of detected outages and degradations

Team Management

Collaborate with your team on shared projects (Starter plan and above):

Inviting Members

  1. Go to Settings > Team
  2. Click Invite Member
  3. Enter the team member's email address
  4. Select a role: Admin, Member, or Viewer
  5. The invited user receives an email with a join link

Roles

RolePermissions
Admin Full access: create/delete projects, manage team, billing, API keys
Member Create projects, run scans, view all results, configure notifications
Viewer View-only access to projects and results

API Keys

API keys authenticate CLI tools and API requests against your account:

Creating an API Key

  1. Go to Settings > API Keys
  2. Click Generate New Key
  3. Give the key a descriptive name (e.g., "CI/CD Pipeline", "Local Dev")
  4. Copy the key immediately — it will not be shown again
Security

Never commit API keys to version control. Store them as environment variables or in your CI/CD platform's secrets manager.

Using API Keys

bash
# Set as environment variable
export HTK_CLOUD_TOKEN=your-api-key

# Or pass directly with --report
tk-scan https://myapp.com --report https://htk-cloud-v4.enzu-agent.workers.dev/api/test-engine/external-report

Notification Settings

Configure how and when you receive alerts:

Available Channels

ChannelPlanDescription
Email Starter+ Email alerts to team members on scan failures
Slack Pro+ Send alerts to a Slack channel via webhook
Webhook Pro+ HTTP POST to a custom URL with JSON payload
Dashboard All In-app notifications visible on the dashboard

Alert Rules

Configure alert triggers per project:

  • Score Drop — Alert when health score drops below a threshold
  • Security Finding — Alert on new critical or high severity findings
  • Performance Degradation — Alert when TTFB or load time exceeds a threshold
  • Downtime — Alert when a route returns a non-2xx/3xx status
  • Visual Regression — Alert when visual diff exceeds threshold
Edit this page on GitHub