Config: feature flags and security
Find the fallow config keys for feature flags and security, with type, default, allowed values and description.
The config file holds the settings of fallow. How config works explains where fallow finds the file and how files merge.
flags
- Type:
object
Configures feature-flag detection: sdkPatterns (custom flag-evaluating call signatures, each { function, nameArg (zero-based arg index of the flag name, default 0), provider? }, merged with built-ins for LaunchDarkly, Statsig, Unleash, GrowthBook, Split, PostHog, Vercel Flags, ConfigCat, Flagsmith, Optimizely, and Eppo), envPrefixes (env-var prefixes marking process.env.* and import.meta.env.* accesses as flags, merged with built-ins), and configObjectHeuristics (default false; when true, property accesses on objects whose name contains feature/flag/toggle are reported as low-confidence flags). Set sdkPatterns/envPrefixes to teach fallow a proprietary flag SDK or naming convention, or enable configObjectHeuristics for projects that read flags off config objects (higher false-positive rate). Feature-flag findings surface only when the feature-flags rule is enabled (default off).
| Key | Type | Default |
|---|---|---|
sdkPatterns | object[] | |
envPrefixes | string[] | |
configObjectHeuristics | boolean | false |
vendorKeyPrefix | string |
flags.sdkPatterns
- Type:
object[]
Additional SDK call patterns to detect as feature flags. These are merged with the built-in patterns for common providers including LaunchDarkly, Statsig, Unleash, GrowthBook, Split, PostHog, Vercel Flags, ConfigCat, Flagsmith, Optimizely, and Eppo.
flags.sdkPatterns[].function
- Type:
string
Function name to match (e.g., "useFlag", "variation").
flags.sdkPatterns[].nameArg
- Type:
integer - Default:
0
Zero-based index of the argument containing the flag name.
flags.sdkPatterns[].provider
- Type:
string(optional)
Optional SDK/provider label shown in output (e.g., "LaunchDarkly").
flags.envPrefixes
- Type:
string[]
Environment variable prefixes that indicate feature flags. Merged with built-in prefixes. Only process.env.* and import.meta.env.* accesses matching these prefixes are reported as feature flags.
flags.configObjectHeuristics
- Type:
boolean - Default:
false
Enable config object heuristic detection. When true, property accesses on objects whose name contains "feature", "flag", or "toggle" are reported as low-confidence feature flags. Default: false (opt-in due to higher false positive rate).
flags.vendorKeyPrefix
- Type:
string(optional)
Prefix to remove from each key of a --flag-state vendor export before the key is compared with the flag names in the code. For example, "web." makes the vendor key web.new-checkout match the code flag new-checkout. A key without the prefix is compared as it is.
security
- Type:
object
Scopes the opt-in fallow security catalogue: which candidate categories run and which extra local identifiers count as HTTP request objects. Set when tuning security-candidate detection; the object holds categories (an object with include and/or exclude string arrays of catalogue category ids, where include restricts to a whitelist and exclude removes from the admitted set, both unset admits all ordinary categories) and requestReceivers (a string array of project-local names that extend, not replace, the built-in *.query/*.params/*.body source-receiver allowlist). The hardcoded-secret and secret-to-network categories are include-required: they fire only when explicitly listed in categories.include, even when no include list is otherwise set. The valid category ids are enumerated (with title, CWE, and include-required flag) in the security_categories block of fallow schema, and also listed by fallow security --help; they are not in this config-schema.
| Key | Type | Default |
|---|---|---|
categories | object | |
requestReceivers | string[] |
security.categories
- Type:
object(optional)
Include/exclude filter over category ids (e.g. dangerous-html).
security.categories.include
- Type:
string[](optional)
Catalogue category ids to admit. When set, all others are excluded.
security.categories.exclude
- Type:
string[](optional)
Catalogue category ids to remove from the admitted set.
security.requestReceivers
- Type:
string[]
Additional project-local names for HTTP request objects. These names extend the built-in receiver allowlist for *.query, *.params, and *.body source patterns. They do not replace the built-ins and do not gate *.searchParams, which intentionally stays ungated.