Skip to main content

vulkro-sf org context

Write the org context (vulkro.sf-org-context/v1) the engine and the Cloud use to judge findings against the live org: every profile, permission set and permission set group with its ACTIVE holders (profile users plus direct and group assignments) and its object Read / Edit / View All / Modify All; whether each class, page, flow, group, remote site, CSP site, connected app, package and user was built by the customer, shipped by Salesforce, or installed from a package; which add-ons are licensed (Field Audit Trail, Platform Encryption, Event Monitoring); the guest site profiles and the objects with a guest sharing rule; and the scanner's own connection. Every read is a SELECT query or a metadata retrieve through your sf login; nothing in the org is changed. The format is documented in cloud/SF_ORG_CONTEXT.md.

Command reference​

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

Write the org context (vulkro.sf-org-context/v1) the engine and the Cloud use to judge findings against the live org: every profile, permission set and permission set group with its ACTIVE holders (profile users plus direct and group assignments) and its object Read / Edit / View All / Modify All; whether each class, page, flow, group, remote site, CSP site, connected app, package and user was built by the customer, shipped by Salesforce, or installed from a package; which add-ons are licensed (Field Audit Trail, Platform Encryption, Event Monitoring); the guest site profiles and the objects with a guest sharing rule; and the scanner's own connection. Every read is a SELECT query or a metadata retrieve through your sf login; nothing in the org is changed. The format is documented in cloud/SF_ORG_CONTEXT.md.

vulkro-sf org context [OPTIONS] --target-org <TARGET_ORG>

Options​

FlagDescription
-t, --target-org <TARGET_ORG>Target org alias or username, as known to sf org login
-O, --output <OUTPUT>Where to write the JSON. Defaults to .vulkro/org-context.json in the current directory; - prints it to stdout.
-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 org context --help
Write the org context (`vulkro.sf-org-context/v1`) the engine and the Cloud use to judge findings against the live org: every profile, permission set and permission set group with its ACTIVE holders (profile users plus direct and group assignments) and its object Read / Edit / View All / Modify All; whether each class, page, flow, group, remote site, CSP site, connected app, package and user was built by the customer, shipped by Salesforce, or installed from a package; which add-ons are licensed (Field Audit Trail, Platform Encryption, Event Monitoring); the guest site profiles and the objects with a guest sharing rule; and the scanner's own connection. Every read is a SELECT query or a metadata retrieve through your `sf` login; nothing in the org is changed. The format is documented in `cloud/SF_ORG_CONTEXT.md`.

`vulkro-sf scan` loads `.vulkro/org-context.json` from the scanned project, so run this from the SFDX project root before scanning.

Exit codes: 0 = context written; 2 = error (the org could not be read or the file could not be written). This command reports no findings, so it never exits 1.

Usage: vulkro-sf org context [OPTIONS] --target-org <TARGET_ORG>

Options:
-t, --target-org <TARGET_ORG>
Target org alias or username, as known to `sf org login`

-O, --output <OUTPUT>
Where to write the JSON. Defaults to `.vulkro/org-context.json` in the current directory; `-` prints it to stdout

-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')