Skip to main content

vulkro-sf impact

Show what would break if a field, label, class or flow were deleted.

Command reference​

Generated from vulkro-sf impact --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.

Show what would break if a field, label, class or flow were deleted.

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

Arguments​

ArgumentDescription
<API_NAME>The metadata API name proposed for deletion, 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 impact --help
Show what would break if a field, label, class or flow were deleted.

Show what breaks if a metadata API name is deleted (impact analysis).

Builds the cross-file reference graph over the SFDX project at <path>, resolves <api-name> to its catalogued definition(s) (label, field, Apex class, Flow), and lists every reference site that would break if the definition were removed, grouped by surface. When the name is referenced nowhere in source it is reported as a candidate-safe delete (with the same best-effort caveat as `whereused`).

This is BEST-EFFORT and conservative: a "candidate-safe" result is not a guarantee. Dynamic references, managed-package callers, and live-org-only wiring are invisible to static source, so always confirm against the live org before deleting.

Exit codes: 0 = candidate-safe (no static reference would break); 1 = at least one reference site would break (impact reported); 2 = error (unscannable path, name not defined in the project).

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

Arguments:
  <API_NAME>
          The metadata API name proposed for deletion, 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