Skip to main content

vulkro-sf login

Sign in and connect this machine to your Vulkro account.

Command reference​

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

Sign in and connect this machine to your Vulkro account.

vulkro-sf login [OPTIONS]

Options​

FlagDescription
--code <CODE>Pairing code to exchange for a lease (e.g. ABCD-1234), for a headless pairing you were handed. Omit it for the browser login (or set VULKRO_ACCOUNT_TOKEN for CI)
-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 login --help
Sign in and connect this machine to your Vulkro account.

Log in to your Vulkro account and install the Salesforce subscription lease. Opens your browser for device authorization (approve there), then stores a short-lived signed lease. Vulkro for Salesforce needs a licence to scan: start the 14-day trial at app.vulkro.com/billing (card required), then sign in here. An account with no plan still signs in: the account is saved, but scanning is refused until a plan exists; the next online sync (or the next login) then brings it here. For CI, create a CI key in your account (app.vulkro.com, Settings) and export it as VULKRO_ACCOUNT_TOKEN: every scanning command signs in with it automatically. This is the same account used by the core `vulkro` CLI; the lease is per-product.

Air-gapped machines do not use login: install a `.lic` with `vulkro-sf activate <file.lic>` instead, or set VULKRO_LICENSE_B64 to the base64 of the `.lic` on an air-gapped CI runner.

Environment: VULKRO_ACCOUNT_URL   - account server base (default https://app.vulkro.com/api) VULKRO_ACCOUNT_TOKEN - a CI key, for non-interactive sign-in (CI) VULKRO_LICENSE_B64   - a base64 .lic for air-gapped CI (no login) VULKRO_OFFLINE=1     - hard-disables login (and every outbound call)

An account with no plan does not stay signed in: after the browser approval an interactive login waits up to 10 minutes for the plan (the 14-day trial at app.vulkro.com/billing, card required), then finishes, or gives up and keeps nothing signed in.

Exit codes: 0 = logged in with a lease; 1 = no plan on the account (stderr ends with `vulkro: license_required`); 2 = error (offline set, account-server failure, an invalid lease, or the browser login was denied / expired / timed out).

Usage: vulkro-sf login [OPTIONS]

Options:
      --code <CODE>
          Pairing code to exchange for a lease (e.g. ABCD-1234), for a headless pairing you were handed. Omit it for the browser login (or set VULKRO_ACCOUNT_TOKEN for CI)

  -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