❓ Frequently Asked Questions — Early CLI
This page covers CLI-specific questions when running early generate-pr.
For shared topics like API keys, token scopes, and permissions, see the Fundamentals FAQ →.
🔐 What permissions do tokens need?
There are two tokens:
1. NPM_TOKEN — for installing the CLI
Used with GitHub Packages.
See Install Token →
2. TOKEN — for Git access and committing files
Used to access commit or PR metadata, push commits, and post comments.
🔑 How do I get my API key?
See API Key →
🧱 Which CI/CD systems are supported?
Any system with Node.js 20+:
- Jenkins
- CircleCI
- GitLab
- Bitbucket
- Self-hosted agents
🧪 Which test frameworks are supported?
- ✅ Jest (required today)
- 🟡 Vitest (coming soon)
- ⚪ Mocha (planned)
📈 What coverage threshold is used?
Currently fixed at 0%.
Only functions with zero coverage will be targeted.
⚙️ How do I handle memory issues?
If you hit a heap error:
export MAX_CONCURRENCY=2
Or:
export NODE_OPTIONS="--max-old-space-size=5120"
See Memory Tuning →
🧩 Can I override the coverage or test commands?
Yes. Use these environment variables:
| Variable | Purpose |
|---|---|
COVERAGE_COMMAND | Run coverage before/after |
TEST_COMMAND | Run test validation |
Flags like --coverageDirectory and --json must stay intact.
See Configuration →
🧾 How does auto-commit work?
When AUTO_COMMIT=true:
- Tests are committed to the branch
- Only passing, valid tests are committed
To disable:
export AUTO_COMMIT=false
🧹 What if my repo enforces lint/format rules?
Use:
export LINT_COMMAND="npx --no eslint $early_filename --fix"
export PRETTIER_COMMAND="npx --no prettier $early_filename --write"
These run before test validation and commit. You can customize the command, just leave the placeholders, as-is.
🧪 Can I run this locally?
Yes. Example:
export API_KEY=...
export TOKEN=...
export HEAD_REF=my-branch
export AUTO_COMMIT=false
early generate-pr
Make sure your machine is configured to access your SCM.
🧰 What if no tests are generated?
Possible reasons:
- All changed code is already covered
- Nothing testable in this PR
- Coverage failed to collect
⚠️ Why did commit fail?
Most likely: the branch changed mid-run and your push was rejected.
Fix:
- Re-run the CLI
🧩 How does this differ from the GitHub Action?
| Option | Usage |
|---|---|
| GitHub Action | PR workflows in GitHub |
| Early CLI | Any CI/CD system |
Both produce identical output.
💬 Still need help?
- 📬 Email: support@startearly.ai
- Slack (for invited teams)