Getting Started

Introduction

Shimpilot continuously monitors the external APIs your applications depend on, maps how those APIs are used inside your repositories, evaluates the risk of upstream changes, and opens reviewable GitHub pull requests to fix breakage before it reaches production.

Quickstart

1. 1. Connect GitHub

   Sign in and install the Shimpilot GitHub App from your dashboard. The app requests a scoped installation — read access plus pull request creation on the repositories you explicitly select, never a full-account OAuth token.

2. 2. Connect a repository

   After installing the app, pick which repositories Shimpilot should watch. Each repository appears on your dashboard with a health score and last-scanned timestamp.

3. 3. Run the first scan

   Trigger a scan from the repository page, or wait for the next scheduled scan. Shimpilot clones the repository into a unique temporary worker workspace, walks its AST for known API call sites, and persists any findings — the clone itself is destroyed immediately afterward, unconditionally, even on failure.

Try it without connecting anything

You can run a real, live scan against any public GitHub repository without signing in, at:

/scan/:owner/:repo

For example, /scan/stripe/stripe-node. This is a real scan, not a mock — it's the same engine your connected repositories use.