Skip to main content
Version: Config V2

Bitbucket Pipe - Scan your source code for feature flags

This section describes how to use ConfigCat's Bitbucket Pipe to automatically scan your source code for feature flag and setting usages and upload the found code references to ConfigCat. You can find more information about Bitbucket Pipelines here.


  1. Create a new ConfigCat Management API credential and store its values in secure pipeline variables with the following names: CONFIGCAT_API_USER, CONFIGCAT_API_PASS.

    Bitbucket Pipe secrets
  2. Get your selected Config's ID.

  3. Add the following snippet to the script section of your bitbucket-pipelines.yml file. Don't forget to replace the PASTE-YOUR-CONFIG-ID-HERE value with your actual Config ID.

    - pipe: configcat/scan-repository-pipe:1.4.4
    # LINE_COUNT: '3' # optional
    # SUB_FOLDER: '/src' # optional
    # EXCLUDE_KEYS: > # optional
    # flag_key_to_exclue_1
    # flag_key_to_exclue_2
    # ALIAS_PATTERNS: (\w+) = :CC_KEY,const (\w+) = feature_flags\.enabled\(:CC_KEY\) # optional
    # VERBOSE: 'true' # optional
  4. Commit & push your changes.

Scan reports are uploaded for each branch of your repository that triggers the job.

Available Options

CONFIG_ID ID of the ConfigCat config to scan against.
LINE_COUNTContext line count before and after the reference line. (min: 1, max: 10)4
SUB_FOLDERSub-folder to scan, relative to the repository root folder.
EXCLUDE_KEYSList of feature flag keys that must be excluded from the scan report.
ALIAS_PATTERNSComma delimited list of custom regex patterns used to search for additional aliases.
VERBOSETurns on detailed logging.false