Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/DevDonzo/warden/llms.txt

Use this file to discover all available pages before exploring further.

warden config helps you manage the .wardenrc.json file that Warden reads at startup. Use it to generate a default configuration for a new project, inspect the resolved configuration in effect for the current directory, or validate an existing file for schema errors before committing it to version control.

​
Synopsis

warden config [options]
With no flags, warden config prints a usage hint: Use --show, --create, or --validate. At least one action flag is required for the command to do anything.

​
Flags

​
--create
boolean
Write a default .wardenrc.json to the current directory (or to the path specified by --path). Warden will not overwrite an existing file — if the target path already exists, the command exits with an error. Delete or rename the existing file first if you want to regenerate it.
​
--show
boolean
Read and print the resolved configuration that Warden would use for the current directory. Useful for verifying that environment-specific overrides and the correct file are being picked up.
​
--validate
boolean
Parse the configuration file and run schema validation against it. Prints a success message if the file is valid, or lists every validation error if it is not. Exits with code 1 on validation failure.
​
--path
string
Override the path to the configuration file. Applies to --create, --show, and --validate. When omitted, Warden looks for .wardenrc.json in the current working directory.

​
Examples

warden config --create

​
Default configuration structure

Running warden config --create generates a .wardenrc.json with safe defaults that you can then customise for your project: 
{
  "scanner": "npm-audit",
  "autoFix": true,
  "createPR": true,
  "severityThreshold": "high",
  "ignoredVulnerabilities": [],
  "labelsForPR": ["security", "warden"],
  "outputFormat": "text",
  "verbose": false,
  "dryRun": false,
  "dast": {
    "enabled": false,
    "targets": [],
    "nmap": {
      "enabled": true,
      "scanType": "standard"
    },
    "metasploit": {
      "enabled": false,
      "mode": "scan-only"
    },
    "safety": {
      "requireConfirmation": true,
      "authorizedTargetsOnly": true,
      "disableExploits": true
    }
  }
}
After creating a default file, run warden config --validate to confirm it passes schema checks before you start editing it. Re-validate each time you modify the file to catch typos or invalid values early.
--create will not overwrite an existing .wardenrc.json. If you want to start fresh, delete or rename the existing file before running warden config --create.
  • warden setup — interactive wizard that creates and populates the configuration file for you
  • warden validate — validate the entire environment, not just the config file
  • warden scan — reads .wardenrc.json at runtime; command-line flags take precedence over file values

Build docs developers (and LLMs) love

Get started for freeTalk to us