Documentation

Introduction

latchkey is an AI-powered CI/CD analytics platform that helps engineering teams identify and fix silent failures, flaky tests, and performance bottlenecks. Get real-time insights into your GitHub Actions workflows, track costs, and optimize your pipeline performance.

Quick Start Guide

Get from zero to dashboard in under 2 minutes:

1. Sign up with your GitHub account
2. Install the latchkey GitHub App
3. Select repositories to monitor
4. View your first insights within minutes

Installation

Install the latchkey GitHub App through our onboarding flow. You'll be prompted to authorize specific permissions that allow us to read workflow metadata and logs. We never access your source code.

Connecting Repositories

During setup, you can choose to monitor specific repositories or grant access to all repositories in your organization. You can always adjust these settings later from your dashboard to stay within your plan's repository limits.

Dashboard Overview

The main dashboard displays key metrics including Success Rate, Run Duration, and Total Cost. Each graph provides interactive tooltips and drill-down capabilities to help you identify trends and anomalies in your CI/CD pipelines.

Workflow Insights

Dive deep into specific metrics like flaky tests (tests that intermittently fail), slow runners, and workflow bottlenecks. Our AI analyzes patterns across all your workflow runs to surface actionable insights.

Performance Optimization

Identify slow runners and expensive workflows with our cost analysis tools. We highlight optimization opportunities such as runner type upgrades, caching improvements, and parallelization strategies.

Alerts & Notifications

Set up real-time email alerts for critical events like workflow failures, cost spikes, or performance degradation. Slack and Microsoft Teams integrations are coming soon.

Plan Overview

latchkey offers three tiers: Launch (up to 10 repositories), Scale (up to 50 repositories), and Enterprise (unlimited repositories). Each plan includes unlimited workflow executions and full access to all analytics features.

Managing Repository Limits

We use a "bucket" model for repository limits. You can archive or uncheck repositories at any time to free up space without upgrading your plan. Only actively monitored repositories count toward your limit.

Open Beta Details

All new accounts receive 30 days free during our Open Beta. You'll be notified before any charges occur, giving you the option to continue with a paid plan or cancel with no obligation.

Upgrading & Downgrading

Change your plan anytime through the billing portal in your account settings. Upgrades take effect immediately, while downgrades occur at the end of your current billing period.

Data Privacy

latchkey analyzes workflow metadata and logs only. We do not clone, store, or access your source code. All data is encrypted in transit and at rest using industry-standard protocols.

Retention Policies

Currently, all workflow data is retained for up to one year. We may introduce tiered retention windows (7 days, 30 days, 1 year) in the future based on your plan tier.

Permissions Explained

The latchkey GitHub App requests read access to workflow runs, jobs, and logs. Write permissions are limited to setting up webhooks for real-time updates. We never request access to repository contents or code.

Common Issues

GitHub API Limits

In rare cases with very high-volume organizations, you may encounter GitHub API rate limits. If this occurs, data sync may be delayed by a few minutes. Contact support if you experience persistent issues.

Contact Support

Need help? Email us at support@latchkey.dev for technical assistance.