CLItrail Docs

Opt-outs

Visitors, developers running your installer, and you as the website owner can each turn attribution off, without breaking the website or the install.

#In the terminal

# Honoured by every tool that follows Console Do Not Track:
export DO_NOT_TRACK=1
# CLItrail only:
export CLITRAIL_DISABLE=1

With either set (to anything but empty, 0 or false), the hook exits with status 0 before it runs a command or reads a file. The install itself is unaffected. Downloading the hook at install time, as the one-liner does, still contacts your service before the hook can check these variables; bundling clitrail.sh with your package avoids that request. A prepared handoff command also downloads the hook, after your command succeeds.

  • CI. The hook also exits straight away when it detects CI: CI set to anything but false or 0, or GITHUB_ACTIONS, GITLAB_CI, BUILDKITE, CIRCLECI, TF_BUILD or JENKINS_URL set. CLITRAIL_ALLOW_CI=1 overrides this, for testing your integration.
  • The notice. In a terminal, the hook prints one line naming the website and how to turn it off. CLITRAIL_QUIET=1 hides the line; it does not turn the hook off.
  • Check. sh clitrail.sh --doctor shows whether an opt-out or CI was detected.

#In the browser

  • Global Privacy Control. Visits made with GPC are never shared with ad platforms. See Global Privacy Control.
  • Your consent choice. Wire your consent banner to enabled; with false the SDK reads, stores and sends nothing. See Consent and opt-out.
  • Clearing site data or private browsing removes the receipt, so the install cannot be matched.

#For website owners

  • Limit the identifiers read with the SDK's providers option.
  • Turn reconstruction off in Settings → Attribution.
  • Keep destinations in test mode, or remove them: nothing leaves CLItrail without a live destination.
  • Shorten the retention period, export, or delete a website and its data at any time.