❓ Frequently Asked Questions — Repo CLI

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

---

🌐 Which languages are supported?

The Repo CLI supports:

• JavaScript and TypeScript — Jest, Mocha, and other frameworks
• Python — pytest (auto-detected)

The CLI automatically detects the project language from file extensions and project markers (e.g., package.json for JS/TS, pyproject.toml or requirements.txt for Python).

---

🐍 How does the CLI know if my project is Python?

The CLI auto-detects the language by inspecting the --target-directory:

• If the target is a .py file, it's treated as Python
• If the target folder contains Python project markers (pyproject.toml, setup.py, setup.cfg, requirements.txt), it's treated as Python
• If the folder contains .py files, it's treated as Python

No --language flag is needed.

---

🔑 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:

• 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?

JavaScript / TypeScript

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 →

Python

No coverage configuration is needed for Python. The agent generates tests directly by analyzing your source code — it identifies testable functions and class methods without requiring a coverage run.

---

📦 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?

JavaScript / TypeScript

You control this via --test-structure:

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

Python

Test files are placed in .early.test/ sibling folders next to the source file:

src/
  utils/
    helpers.py
    helpers.early.test/
      test_my_function_early.py
      test_another_function_early.py

Each testable function gets its own test file.

---

🧪 Can I run this manually?

JavaScript / TypeScript

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.

Python

Yes — install the CLI and py-agent, then run:

npm install -g @earlyai/cli
pip install py-agent

early generate-for-project \
  --api-key $API_KEY \
  --token $TOKEN \
  --target-directory ./src \
  --ref-name main

---

🧹 What about Prettier or ESLint?

Note: This applies to JavaScript/TypeScript projects only. Python does not yet support lint/format hooks.

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?

Command	Use Case	Requires PR Context	Typical Use
generate-pr	Per-pull-request generation	✅ Yes	GitHub PRs
generate-commit	For single commits	❌ No	GitHub push, Jenkins
generate-for-project	Repo folder-based generation	❌ No	Coverage campaigns

Compare: When to Use Which Agent →

---

🆘 Still need help?

• Email us: support@startearly.ai
• View the Central FAQ →