Skip to main content

vulkro-sf lsp

Run as a language server so any editor can show findings inline.

Command reference​

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

Run as a language server so any editor can show findings inline.

vulkro-sf lsp [OPTIONS]

Options​

FlagDescription
--transport <TRANSPORT>LSP transport. Today only stdio is supported. Default: stdio.
--port <PORT>TCP port for a future TCP transport. Reserved; not honoured by today's build (which always speaks LSP over stdio)
-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 lsp --help
Run as a language server so any editor can show findings inline.

Run Vulkro for Salesforce as a Language Server Protocol server.

Speaks LSP over stdio so any editor with an LSP client can stream Salesforce-specific diagnostics from the local engine. The companion VS Code / Cursor / Windsurf extension under `integrations/editors/vscode/` activates on the presence of `sfdx-project.json` in the workspace and spawns this server.

Supported methods: `initialize`, `textDocument/didOpen|didChange|didSave|didClose`, server-pushed `textDocument/publishDiagnostics`, `workspace/executeCommand` (`vulkro-sf.explain` returns the rule's markdown description, `vulkro-sf.suppress` returns a `WorkspaceEdit` that inserts a `// vulkro:disable next-line <rule-id>` annotation, `vulkro-sf.scan-org` triggers an `org perms` audit against the configured target org), `shutdown` + `exit`.

`--transport stdio` (default) is the only supported transport today. The `--port` flag is reserved for a future TCP transport and is rejected by today's build with an actionable error.

Environment variables:

VULKRO_SF_LSP_LOG=1                 Per-message trace lines on stderr. VULKRO_SF_LSP_TARGET_ORG=<alias>    Default target-org for the vulkro-sf.scan-org workspace command. VULKRO_SF_LSP_DEBOUNCE_MS=300       textDocument/didChange debounce window in ms (clamped to 50..=5000; falls back to 300 on parse error).

Exit codes: 0 = clean shutdown (stdin closed or `exit` received); 2 = error (bad arguments, IO failure, internal crash).

Usage: vulkro-sf lsp [OPTIONS]

Options:
      --transport <TRANSPORT>
          LSP transport. Today only `stdio` is supported
          
          [default: stdio]

      --port <PORT>
          TCP port for a future TCP transport. Reserved; not honoured by today's build (which always speaks LSP over stdio)

  -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