Skip to main content

vulkro config

Inspect and explain Vulkro's static configuration.

Today the only action is show-patterns.

Usage​

vulkro config <COMMAND>
CommandDescription
show-patternsPrint the hardcoded pattern lists Vulkro matches against, plus any user-extended additions from vulkro.toml / env vars.

vulkro config show-patterns​

Prints the hardcoded pattern lists the engine matches against:

  • auth middleware names
  • monorepo umbrella directories
  • auth-helper body shapes

plus any user-extended additions picked up from vulkro.toml or environment variables.

Useful before defining a custom auth middleware name: many shapes are already covered by the built-in regexes, so check here before adding a redundant entry.

vulkro config show-patterns

This subcommand takes no arguments and no flags.

Command reference​

Generated from vulkro help config on vulkro 0.26.0. This block is the authoritative flag, usage, and exit-code reference for this command; the prose above is the friendly explanation. Do not edit this block by hand; run npm run docs:cli after a release.

Show the built-in patterns the scanner matches against, plus your own additions.

Inspect and explain vulkro's static configuration. Today the only action is `show-patterns`, which prints the built-in pattern lists Vulkro matches against (auth middleware names, monorepo umbrella directories, auth-helper shapes) plus any user-extended additions picked up from `vulkro.toml` / env vars. Prints a compiled-in / config-derived catalogue; it never scans and needs no license.

Exit code: 0 on success, 2 on error. See each sub-action for details.

Usage: vulkro config [OPTIONS] <COMMAND>

Commands:
  show-patterns  Print the hardcoded pattern lists vulkro matches against, plus any user-extended additions from `vulkro.toml` / env vars. Useful before defining a custom auth middleware name - many shapes are already covered by the built-in regexes
  help           Print this message or the help of the given subcommand(s)

Options:
      --offline
          Hard-disable every outbound network call for this run (sets VULKRO_OFFLINE=1). Blocks the CVE feed, the license heartbeat, the update check, webhooks, and any cloud AI endpoint; a loopback model (http://127.0.0.1, http://localhost) is still allowed. Equivalent to exporting VULKRO_OFFLINE=1, and the flag wins when both are set

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

$ vulkro config show-patterns --help
------------------------------------------------------------
Print the hardcoded pattern lists vulkro matches against, plus any user-extended additions from `vulkro.toml` / env vars. Useful before defining a custom auth middleware name - many shapes are already covered by the built-in regexes.

Exit code: 0 catalogue printed, 2 on error.

Usage: vulkro config show-patterns [OPTIONS]

Options:
      --offline
          Hard-disable every outbound network call for this run (sets VULKRO_OFFLINE=1). Blocks the CVE feed, the license heartbeat, the update check, webhooks, and any cloud AI endpoint; a loopback model (http://127.0.0.1, http://localhost) is still allowed. Equivalent to exporting VULKRO_OFFLINE=1, and the flag wins when both are set

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