Skip to main content

❓ Frequently Asked Questions — Repo CLI

This page covers common questions about using the early generate-folder command to generate tests across an entire folder.

🔑 Where do I get my API key?​

Contact support@startearly.ai to obtain your API key.
Store it securely in your CI system (e.g., EARLY_API_KEY in GitHub Actions or Jenkins).

See: Central FAQ →

🔐 What tokens are required?​

You need:

  • NPM_TOKEN to install @earlyai/cli from GitHub Packages
  • TOKEN for Git access (reading files, committing, commenting)

Details and permissions: Token Guide →
FAQ reference: Central FAQ SCM → and Central FAQ SCM →

🧪 Do I need to configure coverage myself?​

No. The CLI runs your test framework (e.g., Jest) to collect coverage.
You can customize the command via --coverage-command and --test-command.

See: Optional inputs →

More: Central FAQ Test Frameworks →

📦 Can I use this in Jenkins or other CI/CD?​

Yes — the CLI supports GitHub Actions, Jenkins, CircleCI, GitLab, and more.

See CI examples Integration Guide - GitHub example → and Jenkins example →

📁 Where are test files placed?​

You control this via --test-structure:

  • siblingFolder → next to source
  • rootFolder → inside root tests/ folder

🧪 Can I run this manually?​

Yes — you can run it locally or via npx:

npx @earlyai/cli generate-folder \
  --folder ./src \
  --ref-name main \
  --token $TOKEN \
  --api-key $API_KEY

Your machine needs to be configured to work with git and your SCM.

🧹 What about Prettier or ESLint?​

Define:

LINT_COMMAND="npx --no eslint $early_filename --fix"
PRETTIER_COMMAND="npx --no prettier $early_filename --write"

Reference: Central FAQ - Lint Formatting →

🧵 How is this different from generate-pr or generate-commit?​

CommandUse CaseRequires PR ContextTypical Use
generate-prPer-pull-request generation✅ YesGitHub PRs
generate-commitFor single commits❌ NoGitHub push, Jenkins
generate-folderRepo folder-based generation❌ NoCoverage campaigns

Compare: When to Use Which Agent →

🆘 Still need help?​