Skip to content
Latchkey home

latchkey.dev / documentationEnglishPortuguês日本語

Learn how to use Latchkey

Everything you need to connect GitHub, understand your CI analytics, and run jobs on managed self-healing runners. 37 guides, organized in the order you will need them.

Start here four stops, in order

  1. 01What is Latchkey The two-minute product model/what-is-latchkey
  2. 02Quickstart Connect GitHub and run your first job/quickstart
  3. 03First runner job One line of YAML/run-your-first-job
  4. 04Invite your team Roles, seats, invites/team-and-roles

Contents 8 chapters · 37 guides

Getting started 4 guides

What Latchkey is, how to connect GitHub, and how to get your first job running on Latchkey.

  1. 1.1What is Latchkey
  2. 1.2Quickstart
  3. 1.3Install the GitHub App
  4. 1.4Managing repositories

Dashboard & analytics 7 guides

Find your way around the dashboard and get the most out of the cost, performance, and AI insights pages.

  1. 2.1Dashboard at a glance
  2. 2.2The Runs page
  3. 2.3Cost analysis
  4. 2.4Pipeline performance
  5. 2.5AI Insight
  6. 2.6Knowledge base
  7. 2.7Connect your AI agent

Managed runners 11 guides

Fast, ephemeral, self-healing runners for GitHub Actions. One line of YAML to adopt, per-minute billing, free minutes on every plan.

  1. 3.1Runners overview
  2. 3.2Run your first job
  3. 3.3Migrate from GitHub-hosted
  4. 3.4Latchkey CLI
  5. 3.5CLI changelog
  6. 3.6The Runners page
  7. 3.7Custom runners (AI Scan)
  8. 3.8Self-healing
  9. 3.9Runner image & software
  10. 3.10Provisioning & warm pools
  11. 3.11Limits & concurrency

Caching 2 guides

Built-in dependency and Docker layer caching on Latchkey runners: zero configuration, and a cache problem can slow a build down but never fail one.

  1. 4.1Dependency caching
  2. 4.2Docker layer caching

Team & notifications 3 guides

Bring your team into the workspace with the right roles, and route the right alerts to email, Slack, and your browser.

  1. 5.1Team & roles
  2. 5.2Notifications
  3. 5.3Slack integration

Billing & plans 3 guides

Plans, the 30-day trial, managing your subscription and seats, and how runner minutes are metered and billed.

  1. 6.1Plans & trial
  2. 6.2Managing billing
  3. 6.3Usage & free minutes

Help 4 guides

Fix the common problems, get quick answers, and understand exactly what Latchkey can access.

  1. 7.1Troubleshooting
  2. 7.2FAQ
  3. 7.3Security architecture
  4. 7.4Security & permissions

Workflow files 3 guides

Commit a workflow file and Latchkey runs it. The keys the dialect accepts, the keys it refuses by name, and what happens on a push.

  1. 8.1Workflow files
  2. 8.2Steps
  3. 8.3Cloud identity

Give your agents a CI they can drive

Start with a 30-day free trial. No credit card.

Start building for free