schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
tsconfig.json
files
Load "files" and "include" from `tsconfig.json` on startup. Default is to override `tsconfig.json` "files" and "include" to only include the entrypoint script.
{"default": false, "type": "boolean"}
tsconfig.json
ignore
Paths which should not be compiled. Each string in the array is converted to a regular expression via `new RegExp()` and tested against source paths prior to compilation. Source paths are normalized to posix-style separators, relative to the directory containing `tsconfig.json` or to cwd if no `tsconfig.json` is loaded. Default is to ignore all node_modules subdirectories.
{"default": ["(?:^|/)node_modules/"], "items": {"type": "string"}, "type": "array"}
tsconfig.json
ignoreDiagnostics
Ignore TypeScript warnings by diagnostic code.
{"items": {"type": ["string", "number"]}, "type": "array"}
tsconfig.json
logError
Logs TypeScript errors to stderr instead of throwing exceptions.
{"default": false, "type": "boolean"}
tsconfig.json
moduleTypes
Override certain paths to be compiled and executed as CommonJS or ECMAScript modules. When overridden, the tsconfig "module" and package.json "type" fields are overridden, and the file extension is ignored. This is useful if you cannot use .mts, .cts, .mjs, or .cjs file extensions; it achieves the same effect. Each key is a glob pattern following the same rules as tsconfig's "include" array. When multiple patterns match the same file, the last pattern takes precedence. `cjs` overrides matches files to compile and execute as CommonJS. `esm` overrides matches files to compile and execute as native ECMAScript modules. `package` overrides either of the above to default behavior, which obeys package.json "type" and tsconfig.json "module" options.
{}
tsconfig.json
preferTsExts
Re-order file extensions so that TypeScript imports are preferred. For example, when both `index.js` and `index.ts` exist, enabling this option causes `require('./index')` to resolve to `index.ts` instead of `index.js`
{"default": false, "type": "boolean"}
tsconfig.json
pretty
Use pretty diagnostic formatter.
{"default": false, "type": "boolean"}
tsconfig.json
require
Modules to require, like node's `--require` flag. If specified in `tsconfig.json`, the modules will be resolved relative to the `tsconfig.json` file. If specified programmatically, each input string should be pre-resolved to an absolute path for best results.
{"items": {"type": "string"}, "type": "array"}
tsconfig.json
scope
Scope compiler to files within `scopeDir`.
{"default": false, "type": "boolean"}
tsconfig.json
skipIgnore
Skip ignore check, so that compilation will be attempted for all files with matching extensions.
{"default": false, "type": "boolean"}
tsconfig.json
swc
Transpile with swc instead of the TypeScript compiler, and skip typechecking. Equivalent to setting both `transpileOnly: true` and `transpiler: 'ts-node/transpilers/swc'` For complete instructions: https://typestrong.org/ts-node/docs/transpilers
{"type": "boolean"}
tsconfig.json
transpileOnly
Use TypeScript's faster `transpileModule`.
{"default": false, "type": "boolean"}
tsconfig.json
transpiler
Specify a custom transpiler for use with transpileOnly
{"anyOf": [{"items": [{"type": "string"}, {"additionalProperties": true, "properties": {}, "type": "object"}], "maxItems": 2, "minItems": 2, "type": "array"}, {"type": "string"}]}
tsconfig.json
typeCheck
**DEPRECATED** Specify type-check is enabled (e.g. `transpileOnly == false`).
{"default": true, "type": "boolean"}
nuclei-jsonschema.json
cve-id
CVE IDs for the template
{}
nuclei-jsonschema.json
cwe-id
CWE IDs for the template
{}
nuclei-jsonschema.json
cvss-metrics
CVSS Metrics for the template
{"type": "string", "examples": ["3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H"]}
nuclei-jsonschema.json
cvss-score
CVSS Score for the template
{"type": "number"}
nuclei-jsonschema.json
epss-score
EPSS Score for the template
{"type": "number"}
nuclei-jsonschema.json
epss-percentile
EPSS Percentile for the template
{"type": "number"}
nuclei-jsonschema.json
cpe
CPE for the template
{"type": "string", "examples": ["cpe:/a:vendor:product:version"]}
nuclei-jsonschema.json
name
Name is a short summary of what the template does
{"type": "string", "examples": ["Nagios Default Credentials Check"]}
nuclei-jsonschema.json
author
Author is the author of the template
{"$schema": "http://json-schema.org/draft-04/schema#"}
nuclei-jsonschema.json
tags
Any tags for the template
{}
nuclei-jsonschema.json
description
In-depth explanation on what the template does
{"type": "string", "examples": ["Bower is a package manager which stores package information in the bower.json file"]}
nuclei-jsonschema.json
reference
Links relevant to the template
{"$schema": "http://json-schema.org/draft-04/schema#"}
nuclei-jsonschema.json
metadata
Additional metadata fields for the template
{"patternProperties": {".*": {"additionalProperties": true}}, "type": "object"}
nuclei-jsonschema.json
classification
Classification information for the template
{"$schema": "http://json-schema.org/draft-04/schema#"}
nuclei-jsonschema.json
remediation
In-depth explanation on how to fix the issues found by the template
{"type": "string", "examples": ["Change the default administrative username and password of Apache ActiveMQ by editing the file jetty-realm.properties"]}
nuclei-jsonschema.json
severity.Holder
Seriousness of the implications of the template
{"enum": ["info", "low", "medium", "high", "critical", "unknown"], "type": "string"}
nuclei-jsonschema.json
userAgent.UserAgentHolder
userAgent for the headless http request
{"enum": ["off", "default", "custom"], "type": "string"}
nuclei-jsonschema.json
name
Name of the extractor
{"type": "string"}
nuclei-jsonschema.json
regex
Regex to extract from part
{"items": {"type": "string"}, "type": "array"}
nuclei-jsonschema.json
group
Group to extract from regex
{"type": "integer"}
nuclei-jsonschema.json
kval
Kval pairs to extract from response
{"items": {"type": "string"}, "type": "array"}
nuclei-jsonschema.json
json
JSON JQ expressions to evaluate from response part
{"items": {"type": "string"}, "type": "array"}
nuclei-jsonschema.json
xpath
XPath allows using xpath expressions to extract items from html response
{"items": {"type": "string"}, "type": "array"}
nuclei-jsonschema.json
attribute
Optional attribute to extract from response XPath
{"type": "string"}
nuclei-jsonschema.json
dsl
Optional attribute to extract from response dsl
{"items": {"type": "string"}, "type": "array"}
nuclei-jsonschema.json
part
Part of the request response to extract data from
{"type": "string"}
nuclei-jsonschema.json
internal
Internal when set to true will allow using the value extracted in the next request for some protocols
{"type": "boolean"}
nuclei-jsonschema.json
case-insensitive
use case insensitive extract
{"type": "boolean"}
nuclei-jsonschema.json
to
save extracted values to file
{"type": "string"}
nuclei-jsonschema.json
extractors.ExtractorTypeHolder
Type of the extractor
{"enum": ["regex", "kval", "xpath", "json", "dsl"], "type": "string"}
nuclei-jsonschema.json
type
Type of the matcher
{"$schema": "http://json-schema.org/draft-04/schema#"}
nuclei-jsonschema.json
condition
Condition between the matcher variables
{"enum": ["and", "or"], "type": "string"}
nuclei-jsonschema.json
part
Part of response to match data from
{"type": "string"}
nuclei-jsonschema.json
negative
Negative specifies if the match should be reversed. It will only match if the condition is not true
{"type": "boolean"}
nuclei-jsonschema.json
name
Name of the matcher
{"type": "string"}
nuclei-jsonschema.json
status
Status to match for the response
{"items": {"type": "integer"}, "type": "array"}
nuclei-jsonschema.json
size
Size is the acceptable size for the response
{"items": {"type": "integer"}, "type": "array"}
nuclei-jsonschema.json
words
Words contains word patterns required to be present in the response part
{"items": {"type": "string"}, "type": "array"}
nuclei-jsonschema.json
regex
Regex contains regex patterns required to be present in the response part
{"items": {"type": "string"}, "type": "array"}
nuclei-jsonschema.json
binary
Binary are the binary patterns required to be present in the response part
{"items": {"type": "string"}, "type": "array"}
nuclei-jsonschema.json
dsl
DSL are the dsl expressions that will be evaluated as part of nuclei matching rules
{"items": {"type": "string"}, "type": "array"}
nuclei-jsonschema.json
encoding
Optional encoding for the word fields
{"enum": ["hex"], "type": "string"}
nuclei-jsonschema.json
case-insensitive
use case insensitive match
{"type": "boolean"}
nuclei-jsonschema.json
match-all
match all matcher values ignoring condition
{"type": "boolean"}
nuclei-jsonschema.json
matchers.MatcherTypeHolder
Type of the matcher
{"enum": ["word", "regex", "binary", "status", "size", "dsl"], "type": "string"}
nuclei-jsonschema.json
type
Type of fuzzing rule to perform
{"enum": ["replace", "prefix", "postfix", "infix"], "type": "string"}
nuclei-jsonschema.json
part
Part of request rule to fuzz
{"enum": ["query"], "type": "string"}
nuclei-jsonschema.json
mode
Mode of request rule to fuzz
{"enum": ["single", "multiple"], "type": "string"}
nuclei-jsonschema.json
keys
Keys of parameters to fuzz
{"items": {"type": "string"}, "type": "array"}
nuclei-jsonschema.json
keys-regex
Regex of parameter keys to fuzz
{"items": {"type": "string"}, "type": "array"}
nuclei-jsonschema.json
values
Regex of parameter values to fuzz
{"items": {"type": "string"}, "type": "array"}
nuclei-jsonschema.json
fuzz
Payloads to perform fuzzing substitutions with
{"items": {"type": "string"}, "type": "array"}
nuclei-jsonschema.json
generators.AttackTypeHolder
Type of the attack
{"enum": ["batteringram", "pitchfork", "clusterbomb"], "type": "string"}
nuclei-jsonschema.json
variables.Variable
Additional variables for the request
{"additionalProperties": true, "type": "object"}
nuclei-jsonschema.json
dns.DNSRequestTypeHolder
Type is the type of DNS request to make
{"enum": ["A", "NS", "DS", "CNAME", "SOA", "PTR", "MX", "TXT", "AAAA", "CAA", "TLSA", "ANY"], "type": "string"}
nuclei-jsonschema.json
matchers
Detection mechanism to identify whether the request was successful by doing pattern matching
{"items": {}, "type": "array"}
nuclei-jsonschema.json
extractors
Extractors contains the extraction mechanism for the request to identify and extract parts of the response
{"items": {}, "type": "array"}
nuclei-jsonschema.json
matchers-condition
Conditions between the matchers
{"enum": ["and", "or"], "type": "string"}
nuclei-jsonschema.json
id
ID is the optional ID of the DNS Request
{"type": "string"}
nuclei-jsonschema.json
name
Name is the Hostname to make DNS request for
{"type": "string"}
nuclei-jsonschema.json
type
Type is the type of DNS request to make
{"$schema": "http://json-schema.org/draft-04/schema#"}
nuclei-jsonschema.json
class
Class is the class of the DNS request
{"enum": ["inet", "csnet", "chaos", "hesiod", "none", "any"], "type": "string"}
nuclei-jsonschema.json
retries
Retries is the number of retries for the DNS request
{"type": "integer"}
nuclei-jsonschema.json
trace
Trace performs a trace operation for the target.
{"type": "boolean"}
nuclei-jsonschema.json
trace-max-recursion
TraceMaxRecursion is the number of max recursion allowed for trace operations
{"type": "integer"}
nuclei-jsonschema.json
attack
Attack is the type of payload combinations to perform
{}
nuclei-jsonschema.json
payloads
Payloads contains any payloads for the current request
{"patternProperties": {".*": {"additionalProperties": true}}, "type": "object"}
nuclei-jsonschema.json
recursion
Recursion determines if resolver should recurse all records to get fresh results
{"type": "boolean"}
nuclei-jsonschema.json
resolvers
Define resolvers to use within the template
{"items": {"type": "string"}, "type": "array"}
nuclei-jsonschema.json
matchers
Detection mechanism to identify whether the request was successful by doing pattern matching
{"items": {}, "type": "array"}
nuclei-jsonschema.json
extractors
Extractors contains the extraction mechanism for the request to identify and extract parts of the response
{"items": {}, "type": "array"}
nuclei-jsonschema.json
matchers-condition
Conditions between the matchers
{"enum": ["and", "or"], "type": "string"}
nuclei-jsonschema.json
extensions
List of extensions to perform matching on
{"items": {"type": "string"}, "type": "array"}
nuclei-jsonschema.json
denylist
List of files
{"items": {"type": "string"}, "type": "array"}
nuclei-jsonschema.json
id
ID is the optional ID for the request
{"type": "string"}
nuclei-jsonschema.json
max-size
Maximum size of the file to run request on
{"type": "string"}
nuclei-jsonschema.json
archive
Process compressed archives without unpacking
{"type": "boolean"}
nuclei-jsonschema.json
mime-type
Filter files by mime-type
{"type": "boolean"}
nuclei-jsonschema.json
no-recursive
Specifies whether to not do recursive checks if folders are provided
{"type": "boolean"}
nuclei-jsonschema.json
id
Optional ID of the headless request
{"type": "string"}
nuclei-jsonschema.json
attack
Attack is the type of payload combinations to perform
{}
nuclei-jsonschema.json
payloads
Payloads contains any payloads for the current request
{"patternProperties": {".*": {"additionalProperties": true}}, "type": "object"}
nuclei-jsonschema.json
steps
List of actions to run for headless request
{"items": {"$schema": "http://json-schema.org/draft-04/schema#"}, "type": "array"}
nuclei-jsonschema.json
user_agent
User agent for the headless request
{"$schema": "http://json-schema.org/draft-04/schema#"}
nuclei-jsonschema.json
custom_user_agent
Custom user agent for the headless request
{"type": "string"}
nuclei-jsonschema.json
stop-at-first-match
Stop the execution after a match is found
{"type": "boolean"}