Skip to main content

❓ Frequently Asked Questions — Fundamentals

This page contains general-purpose answers that apply to all Early agents (PR, Commit, Folder, CLI).
Each agent may also have its own specialized FAQ page for platform-specific behavior.

🔑 How do I get my API key?​

Contact us at support@startearly.ai.
You’ll receive a team-specific API key to run test generation in any CI or locally.

🔐 Do I need a source control token?​

Yes. All agents require an scm token to:

  • Read pull request metadata
  • Push commits with generated tests
  • Comment on PRs (optional)

Use either:

  • GITHUB_TOKEN (GitHub Actions only)
  • Classic PAT (with repo, read:packages)
  • Fine-grained PAT (see Token Permissions)

🧪 Which test frameworks are supported?​

FrameworkStatus
Jest✅ Supported
Mocha🟡 Planned
Vitest🟡 Planned
Pytest🟡 In Beta

🧠 What files will get tests?​

Early only generates tests for:

  • Functions with 0% coverage
  • In supported languages (currently JavaScript and TypeScript)
  • Inside your target folder or changed commit range

Future versions will support setting a custom coverage threshold.

⚙️ Why does it skip some files?​

  • The function is already covered.
  • The file is not testable (e.g., config files, typings, test helpers).
  • The language is not supported.
  • The file isn't part of the scanned range (PR diff, folder, or commit).

Check your logs to see which files were scanned and skipped.

📦 Why won’t the CLI install?​

You must configure GitHub Packages access using a classic token. Add this to .npmrc:

@earlyai:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${NPM_TOKEN}

Use a classic Personal Access Token with read:packages scope.
See Installation.

💬 Where can I get help?​

👉 Also see: