Skip to main content

vulkro-sf whereused

List every place a field, label, class or flow is referenced.

Command reference​

Generated from vulkro-sf whereused --help (vulkro-sf 0.28.0). Run scripts/gen-docs.sh in the product repository to refresh it; do not edit this section by hand.

List every place a field, label, class or flow is referenced.

vulkro-sf whereused [OPTIONS] <API_NAME> [PATH]

Arguments​

ArgumentDescription
<API_NAME>The metadata API name to look up, e.g. Region__c, Welcome_Message, AccountService, Onboarding_Flow
[PATH]Path to the SFDX project or retrieved metadata (defaults to the current directory) Default: ..

Options​

FlagDescription
-f, --format <FORMAT>Output format: table or json. Default: table.
-v, --verbose...Bump stderr log verbosity. -v enables debug-level tracing for the vulkro + vulkro_sf targets; -vv enables trace. Honoured only when RUST_LOG is unset (an explicit RUST_LOG always wins)
-q, --quietPrint only warnings and errors on stderr: no progress, tips or next-step hints. Results on stdout and exit codes are unchanged.
--no-colorTurn off coloured output. Colour is also off when NO_COLOR is set to a non-empty value or TERM=dumb.
-h, --helpPrint help (see a summary with '-h')
Full vulkro-sf whereused --help
List every place a field, label, class or flow is referenced.

List every place a metadata API name is referenced (where-used).

Builds the cross-file reference graph over the SFDX project at <path> and lists every reference site for <api-name>: each Apex / LWC / Aura / Visualforce / Flow / layout / report surface that reaches it, with the file, line, and a short surface label (`apex-soql`, `lwc-template`, `flow-subflow`, ...). The lookup is case-insensitive (Salesforce API names are) and spans every kind: a query for `Status` reports references to both a field and a class of that name.

This is BEST-EFFORT. Cross-file reference detection over Salesforce metadata is heuristic: dynamic SOQL, `Type.forName`, reflection, managed-package callers, and live-org-only declarative wiring are invisible to static source. Treat an empty result as "no static reference found", not as proof the object is unused.

Exit codes: 0 = at least one reference found; 1 = the name is known to the project but referenced nowhere in source (a where-used "miss" worth surfacing in CI, mirroring the findings-reported convention); 2 = error (unscannable path, name not defined in the project).

Usage: vulkro-sf whereused [OPTIONS] <API_NAME> [PATH]

Arguments:
  <API_NAME>
          The metadata API name to look up, e.g. `Region__c`, `Welcome_Message`, `AccountService`, `Onboarding_Flow`

  [PATH]
          Path to the SFDX project or retrieved metadata (defaults to the current directory)
          
          [default: .]

Options:
  -f, --format <FORMAT>
          Output format: table or json
          
          [default: table]

  -v, --verbose...
          Bump stderr log verbosity. `-v` enables debug-level tracing for the `vulkro` + `vulkro_sf` targets; `-vv` enables trace. Honoured only when `RUST_LOG` is unset (an explicit `RUST_LOG` always wins)

  -q, --quiet
          Print only warnings and errors on stderr: no progress, tips or next-step hints. Results on stdout and exit codes are unchanged

      --no-color
          Turn off coloured output. Colour is also off when NO_COLOR is set to a non-empty value or TERM=dumb

  -h, --help
          Print help (see a summary with '-h')
Last updated on