Quickstart

Step 1 — Install the GitHub App

Go to buildpathio.com/login/signup.html and create your account. Once you've signed up, you'll be prompted to install the Buildpathio GitHub App on your organization or personal account.

Grant access to the repositories you want to scan. Buildpathio requests read-only access to code and write access to commit statuses (required to post PR checks).

Step 2 — Configure buildpath.yaml

Add a buildpath.yaml to the root of each repository you want Buildpathio to scan:

version: "1"

scan_targets:
  - path: ./services/
    type: auto-detect

risk_threshold:
  block_merge: 70
  require_review: 40

notify:
  slack_channel: "#platform-alerts"

The minimal config only requires version and scan_targets. All other fields are optional.

Step 3 — Push a branch and see the first graph

Push any branch to your repository. Buildpathio will automatically trigger a scan. Within approximately 90 seconds (for repos up to 25 services), the scan completes and posts a PR check.

Go to the pull request on GitHub — you'll see a buildpath/risk-score check in the Checks section with your current risk score.

Step 4 — Interpret your first risk score

The risk score is a number from 0 to 100:

Range	Level	What happens
0–30	LOW	PR check passes. Safe to merge after normal review.
31–65	MEDIUM	PR check requires review. Slack notification sent to configured channel.
66–100	HIGH	PR check blocks merge. Senior engineer override required via CLI or web dashboard.

Next steps

• Read the Dependency Graph docs to understand how Buildpathio builds your service map
• Configure risk scoring thresholds for your team's risk tolerance
• Explore the API to build custom integrations or dashboards