Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Configuration reference

Generated from jevgate.schema.json, which is generated from the configuration types. Configuration explains how the keys work together.

KeyTypeMeaning
cache_ttl_secsintegerCache lifetime in seconds for the jev-latest and jev-preview aliases; pinned versions never expire. Default: 3600.
concurrencyintegerCeiling on simultaneous requests (1-8). Default: 6.
contextlist of stringsFiles always sent as related evidence, like --context.
fail_onlist of stringsThe level for rules without their own, like --fail-on. Default: [“review”].
generatedlist of stringsGlobs of generated files, which are skipped, in addition to the built-in names.
include_testsbooleanJudge tests, like --include-tests. Default: false.
max_context_bytesintegerCeiling on context bytes per request. Default: 32768.
max_file_bytesintegerFiles larger than this are reported as needs-context, never truncated. Default: 262144.
max_requestsintegerCeiling on API attempts per invocation; flags can only lower it. Default: unlimited.
modelstringTypeSafe model; a pinned version keeps results repeatable. --model overrides it.
rulesrules list or tableA list selects rules; a table gives each group or rule a level. Default: the default group.
scopelist of tablesGate levels for the files some paths match, such as report-only tooling.
testslist of stringsGlobs of additional test files.
upload_allowlist of stringsGlobs of the paths that may be uploaded, including instruction files and context. Default: every path.
upload_denylist of stringsGlobs never uploaded, even when allowed.

[[scope]]

[[scope]]: gate levels for the files paths match. fail_on applies to every rule there, and rules to single rules or groups. The last scope that matches a file and addresses a rule wins; other files and rules keep the levels set outside scopes.

KeyTypeMeaning
fail_onlist of stringsThe level for every rule in these files.
pathslist of stringsGlobs of the files this scope applies to.
rulesobjectLevels of single rules or groups in these files; off is not accepted (use upload_deny).

Levels

review, consider, uncertain, report, none, off. off is accepted in [rules] only.

Rule names

maintainability/file-organization, file_organization, maintainability/function-simplification, function_simplification, maintainability/shared-logic, shared_logic, maintainability/hardcoded-values, hardcoded_values, security/injection, injection, security/sensitive-data, sensitive_data, security/unsafe-settings, unsafe_settings, security/access-control, access_control, security/workflows, workflows, tests/value, test_value, tests/redundancy, test_redundancy, documentation/agent-context, agent_context, documentation/large-docs, large_docs, documentation/staleness, doc_staleness, documentation/duplication, doc_duplication, documentation/comments, comments, maintainability, security, tests, documentation, default, all.