ValGuide Docs
EngineeringEngineering Reference

Install And Dev Telemetry

ValGuide tracks anonymous usage signals so maintainers can understand whether contributors install the local CLI, start development targets, and run hosted deployments with analytics enabled. Local CLI telemetry uses a dedicated public PostHog project token by default.

Signals

Local CLI telemetry sends only coarse events:

EventTriggerProperties
val.install.completedpnpm val:setup completeswhether the configured bin directory is already on PATH
val.dev.startedval dev starts local developmenttarget count, all/remote/offline mode, selected database environment

The CLI does not send command arguments, target names, file paths, environment values, repository paths, git remotes, project data, personal data, or secrets. Events use an anonymous UUID stored in ~/.config/valguide/telemetry.json.

Hosted usage is measured through the existing PostHog product analytics path when VITE_POSTHOG_ENABLED=true and a public PostHog key/host are configured for the deployment. Self-hosted deployments can leave analytics disabled.

Opt Out

Use any of these options:

val telemetry disable
VALGUIDE_TELEMETRY_DISABLED=1 val dev studio
VALGUIDE_TELEMETRY_ENABLED=0 val dev studio

val telemetry enable removes the local opt-out. CI environments are skipped automatically.

Configuration

CLI telemetry uses the built-in ValGuide CLI telemetry project by default. Use one of these public PostHog project-key variables only when overriding the destination:

  • VALGUIDE_TELEMETRY_KEY
  • POSTHOG_PROJECT_KEY
  • VITE_POSTHOG_KEY

val telemetry status reports whether the active project key comes from the built-in default or from an environment override. The endpoint is PostHog EU capture. Network failures are ignored and never fail the developer command.

On this page