⚙️ Configuration — early generate-for-project

The early generate-for-project CLI command lets you boost coverage across a selected folder or file. It accepts configuration via CLI flags or environment variables.

For memory, tokens, formatting, or concurrency guidance, refer to:

🔑 Required Inputs

These flags are required for both JavaScript/TypeScript and Python projects:

Variable	CLI Flag	Description	Required	Default
API_KEY	-k, --api-key	Early API key	✅ Yes	–
TOKEN	-t, --token	SCM token with repo access	✅ Yes	–
TARGET_DIRECTORY	--target-directory	File or directory to scan for untested code	✅ Yes	–
REF_NAME	--ref-name	Git branch name	✅ Yes	–

⚙️ Optional Inputs

JavaScript / TypeScript
Python

Variable	CLI Flag	Description	Default
TEST_STRUCTURE	-s, --test-structure	Folder structure: `siblingFolder` or `rootFolder`.	siblingFolder
TEST_FRAMEWORK	-f, --test-framework	Test framework: `jest`, `mocha`, etc.	jest
TEST_FILE_SUFFIX	--test-suffix	Test file suffix (e.g. `test`, `spec`).	test
TEST_FILE_NAMING	--test-file-naming	Naming style: `camelCase`, `snake_case`, `kebab-case`.	camelCase
MAX_TESTABLES	--max-testables	Max number of methods to generate tests for. See MAX testables	30
SKIP_COVERAGE_AFTER	--skip-coverage-after	Skip calculating coverage after test generation. See Skip coverage after	false
MAX_CONCURRENCY	-c, --max-concurrency	Parallel workers (1–4). See Concurrency Guide	1
AUTO_COMMIT	--auto-commit	Commit generated files: `true` or `false`.	true
TEST_COMMAND	--test-command	Validate tests via custom command	See Agent Jest Commands →
COVERAGE_COMMAND	--coverage-command	Custom command to collect coverage	See Agent Jest Commands →
CONTINUE-ON_TEST_ERRORS	--continue-on-test-errors	Continue the operation if current tests fail.	See Agent Jest Commands - tests fail →
LINT_COMMAND	--lint-command	Linting command. See Lint & Format	`npx --no eslint $early_filename --fix`
PRETTIER_COMMAND	--prettier-command	Prettier formatting command. See Lint & Format	`npx --no prettier $early_filename --write`
GIT_USER_EMAIL	--git-user-email	Commit author email	217573370+Early-Agent[bot]@users.noreply.github.com
GIT_USER_NAME	--git-user-name	Commit author name	–
SCM_PROVIDER	--scm-provider	`github`, `bitbucket`, etc. See SCM Support

⚠️ If using MAX_CONCURRENCY>1, set NODE_OPTIONS for memory:

export NODE_OPTIONS="--max-old-space-size=5120"

Variable	CLI Flag	Description	Default
TEST_STRUCTURE	-s, --test-structure	Folder structure: `siblingFolder` or `rootFolder`.	siblingFolder
TEST_FILE_NAMING	--test-file-naming	Naming style: `camelCase` or `kebabCase`.	camelCase
MAX_CONCURRENCY	-c, --max-concurrency	Parallel workers (1–3).	3
AUTO_COMMIT	--auto-commit	Commit and push generated test files: `true` or `false`.	true
AUTO_COMMIT_SKIP_CI	--auto-commit-skip-ci	Append `[skip ci]` to the auto-commit message.	true
GIT_USER_EMAIL	--git-user-email	Commit author email.	Early-Agent[bot] noreply address
GIT_USER_NAME	--git-user-name	Commit author name.	early-agent[bot]
SCM_PROVIDER	--scm-provider	`github` or `bitbucket`. See SCM Support	github

Note: The test framework is automatically set to pytest for Python projects. Options like --test-command, --coverage-command, --lint-command, and --prettier-command are not yet supported for Python.

Auto-commit and required inputs

When AUTO_COMMIT is enabled (the default), the CLI checks out the branch specified by REF_NAME, commits any generated .early. test files, and pushes to the remote. This requires:

TOKEN — used to authenticate the git push. The token must have write access to the repository.
REF_NAME — the branch to check out and push to. Must exist on the remote.

Set AUTO_COMMIT=false if you want to inspect generated tests before committing, or if your CI pipeline handles commits separately.

🧹 Recommended Formatting

JavaScript / TypeScript
Python

If your repository enforces linting or formatting rules, you should define custom commands to align with them.

See this guide to see the defaults and how to change them if needed Lint & Format →

💡 Example: CLI Invocation

JavaScript / TypeScript
Python

early generate-for-project \
  --api-key <your_api_key> \
  --token <your_github_token> \
  --target-directory <path_to_file_or_directory> \
  --ref-name <branch_name>

early generate-for-project \
  --api-key <your_api_key> \
  --token <your_github_token> \
  --target-directory <path_to_file_or_directory> \
  --ref-name <branch_name>

--target-directory can be a single .py file (e.g., src/utils/helpers.py) or a folder (e.g., src/). When given a folder, all .py files are scanned recursively.

✅ Best Practice

Prefer environment variables in CI for simplicity and safety. Avoid logging secrets in plaintext.

🔑 Required Inputs​

⚙️ Optional Inputs​

Auto-commit and required inputs​

🧹 Recommended Formatting​

💡 Example: CLI Invocation​

✅ Best Practice​

📚 Next Steps​