description: A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).

description: The address expressed as a byte offset from the start of the addressable region.

description: The address expressed as a byte offset from the absolute address of the top-most parent object.

description: The number of bytes in this range of addresses.

description: An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.

description: A name that is associated with the address, e.g., '.text'.

description: A human-readable fully qualified name that is associated with the address.

description: The byte offset of this address from the absolute or relative address of the parent object.

description: The index within run.addresses of the cached object for this address.

description: The index within run.addresses of the parent object.

description: Key/value pairs that provide additional information about the address.

$ref: #/definitions/propertyBag

description: A single artifact. In some cases, this artifact might be nested within another artifact.

description: A short description of the artifact.

$ref: #/definitions/message

description: The location of the artifact.

$ref: #/definitions/artifactLocation

description: Identifies the index of the immediate parent of the artifact, if this artifact is nested.

description: The offset in bytes of the artifact within its containing artifact.

description: The length of the artifact in bytes.

description: The role or roles played by the artifact in the analysis.

enum: analysisTarget attachment responseFile resultFile standardStream tracedFile unmodified modified added deleted renamed uncontrolled driver extension translation taxonomy policy referencedOnCommandLine memoryContents directory userSpecifiedConfiguration toolSpecifiedConfiguration debugOutputFile

description: The MIME type (RFC 2045) of the artifact.

description: The contents of the artifact.

$ref: #/definitions/artifactContent

description: Specifies the encoding for an artifact object that refers to a text file.

description: Specifies the source language for any artifact object that refers to a text file that contains source code.

description: A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.

description: The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See "Date/time properties" in the SARIF spec for the required format.

format: date-time

description: Key/value pairs that provide additional information about the artifact.

description: A change to a single artifact.

description: The location of the artifact to change.

description: An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.

$ref: #/definitions/replacement

description: Key/value pairs that provide additional information about the change.

required: artifactLocation replacements

description: Represents the contents of an artifact.

description: UTF-8-encoded content from a text artifact.

description: MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.

description: An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region).

$ref: #/definitions/multiformatMessageString

description: Key/value pairs that provide additional information about the artifact content.

description: Specifies the location of an artifact.

description: A string containing a valid relative or absolute URI.

format: uri-reference

description: A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

description: The index within the run artifacts array of the artifact object associated with the artifact location.

description: A short description of the artifact location.

description: Key/value pairs that provide additional information about the artifact location.

description: An artifact relevant to a result.

description: A message describing the role played by the attachment.

description: The location of the attachment.

description: An array of regions of interest within the attachment.

$ref: #/definitions/region

description: An array of rectangles specifying areas of interest within the image.

$ref: #/definitions/rectangle

description: Key/value pairs that provide additional information about the attachment.

description: A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.

description: A message relevant to the code flow.

description: An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.

$ref: #/definitions/threadFlow

description: Key/value pairs that provide additional information about the code flow.

description: Information about how a specific rule or notification was reconfigured at runtime.

description: Specifies how the rule or notification was configured during the scan.

$ref: #/definitions/reportingConfiguration

description: A reference used to locate the descriptor whose configuration was overridden.

description: Key/value pairs that provide additional information about the configuration override.

required: configuration descriptor

description: Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.

description: A tool object that describes the converter.

$ref: #/definitions/tool

description: An invocation object that describes the invocation of the converter.

$ref: #/definitions/invocation

description: The locations of the analysis tool's per-run log files.

description: Key/value pairs that provide additional information about the conversion.

description: Represents a directed edge in a graph.

description: A string that uniquely identifies the edge within its graph.

description: A short description of the edge.

description: Identifies the source node (the node at which the edge starts).

description: Identifies the target node (the node at which the edge ends).

description: Key/value pairs that provide additional information about the edge.

required: id sourceNodeId targetNodeId

description: Represents the traversal of a single edge during a graph traversal.

description: Identifies the edge being traversed.

description: A message to display to the user as the edge is traversed.

description: The values of relevant expressions after the edge has been traversed.

description: The number of edge traversals necessary to return from a nested graph.

description: Key/value pairs that provide additional information about the edge traversal.

description: A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal.

description: A message that describes the exception.

description: The sequence of function calls leading to the exception.

$ref: #/definitions/stack

description: An array of exception objects each of which is considered a cause of this exception.

$ref: #/definitions/exception

description: Key/value pairs that provide additional information about the exception.

description: The URI of the JSON schema corresponding to the version of the external property file format.

description: The SARIF format version of this external properties object.

description: A stable, unique identifier for this external properties object, in the form of a GUID.

description: A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.

description: A conversion object that will be merged with a separate run.

$ref: #/definitions/conversion

description: An array of graph objects that will be merged with a separate run.

$ref: #/definitions/graph

description: Key/value pairs that provide additional information that will be merged with a separate run.

description: An array of artifact objects that will be merged with a separate run.

$ref: #/definitions/artifact

description: Describes the invocation of the analysis tool that will be merged with a separate run.

description: An array of logical locations such as namespaces, types or functions that will be merged with a separate run.

description: An array of threadFlowLocation objects that will be merged with a separate run.

description: An array of result objects that will be merged with a separate run.

description: Tool taxonomies that will be merged with a separate run.

description: The analysis tool object that will be merged with a separate run.

description: Tool extensions that will be merged with a separate run.

description: Tool policies that will be merged with a separate run.

description: Tool translations that will be merged with a separate run.

description: Addresses that will be merged with a separate run.

description: Requests that will be merged with a separate run.

description: Responses that will be merged with a separate run.

description: Key/value pairs that provide additional information about the external properties.

description: The location of the external property file.

description: A stable, unique identifier for the external property file in the form of a GUID.

description: A non-negative integer specifying the number of items contained in the external property file.

description: Key/value pairs that provide additional information about the external property file.

description: References to external property files that should be inlined with the content of a root log file.

description: An external property file containing a run.conversion object to be merged with the root log file.

description: An array of external property files containing a run.graphs object to be merged with the root log file.

description: An external property file containing a run.properties object to be merged with the root log file.

description: An array of external property files containing run.artifacts arrays to be merged with the root log file.

description: An array of external property files containing run.invocations arrays to be merged with the root log file.

description: An array of external property files containing run.logicalLocations arrays to be merged with the root log file.

description: An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.

description: An array of external property files containing run.results arrays to be merged with the root log file.

description: An array of external property files containing run.taxonomies arrays to be merged with the root log file.

description: An array of external property files containing run.addresses arrays to be merged with the root log file.

description: An external property file containing a run.driver object to be merged with the root log file.

description: An array of external property files containing run.extensions arrays to be merged with the root log file.

description: An array of external property files containing run.policies arrays to be merged with the root log file.

description: An array of external property files containing run.translations arrays to be merged with the root log file.

description: An array of external property files containing run.requests arrays to be merged with the root log file.

description: An array of external property files containing run.responses arrays to be merged with the root log file.

description: Key/value pairs that provide additional information about the external property files.

description: A proposed fix for the problem represented by a result object. A fix specifies a set of artifacts to modify. For each artifact, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.

description: A message that describes the proposed fix, enabling viewers to present the proposed change to an end user.

description: One or more artifact changes that comprise a fix for a result.

description: Key/value pairs that provide additional information about the fix.

description: A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).

description: A description of the graph.

description: An array of node objects representing the nodes of the graph.

description: An array of edge objects representing the edges of the graph.

description: Key/value pairs that provide additional information about the graph.

description: Represents a path through a graph.

description: The index within the run.graphs to be associated with the result.

description: The index within the result.graphs to be associated with the result.

description: A description of this graph traversal.

description: Values of relevant expressions at the start of the graph traversal that may change during graph traversal.

description: Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.

description: The sequences of edges traversed by this graph traversal.

description: Key/value pairs that provide additional information about the graph traversal.

description: The runtime environment of the analysis tool run.

description: The command line used to invoke the tool.

description: An array of strings, containing in order the command line arguments passed to the tool from the operating system.

description: The locations of any response files specified on the tool's command line.

description: The Coordinated Universal Time (UTC) date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.

description: The Coordinated Universal Time (UTC) date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format.

description: The process exit code.

description: An array of configurationOverride objects that describe rules related runtime overrides.

description: An array of configurationOverride objects that describe notifications related runtime overrides.

description: A list of runtime conditions detected by the tool during the analysis.

description: A list of conditions detected by the tool that are relevant to the tool's configuration.

description: The reason for the process exit.

description: The name of the signal that caused the process to exit.

description: The numeric value of the signal that caused the process to exit.

description: The reason given by the operating system that the process failed to start.

description: Specifies whether the tool's execution completed successfully.

description: The machine that hosted the analysis tool run.

description: The account that ran the analysis tool.

description: The process id for the analysis tool run.

description: An absolute URI specifying the location of the analysis tool's executable.

description: The working directory for the analysis tool run.

description: The environment variables associated with the analysis tool process, expressed as key/value pairs.

description: A file containing the standard input stream to the process that was invoked.

description: A file containing the standard output stream from the process that was invoked.

description: A file containing the standard error stream from the process that was invoked.

description: A file containing the interleaved standard output and standard error stream from the process that was invoked.

description: Key/value pairs that provide additional information about the invocation.

description: A location within a programming artifact.

description: Value that distinguishes this location from all other locations within a single result object.

description: Identifies the artifact and region.

description: The logical locations associated with the result.

description: A message relevant to the location.

description: A set of regions relevant to the location.

description: An array of objects that describe relationships between this location and others.

description: Key/value pairs that provide additional information about the location.

description: Information about the relation of one location to another.

description: A reference to the related location.

description: A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'.

description: A description of the location relationship.

description: Key/value pairs that provide additional information about the location relationship.

description: A logical location of a construct that produced a result.

description: Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.

description: The index within the logical locations array.

description: The human-readable fully qualified name of the logical location.

description: The machine-readable name for the logical location, such as a mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.

description: Identifies the index of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.

description: The type of construct this logical location component refers to. Should be one of 'function', 'member', 'module', 'namespace', 'parameter', 'resource', 'returnType', 'type', 'variable', 'object', 'array', 'property', 'value', 'element', 'text', 'attribute', 'comment', 'declaration', 'dtd' or 'processingInstruction', if any of those accurately describe the construct.

description: Key/value pairs that provide additional information about the logical location.

description: Encapsulates a message intended to be read by the end user.

description: A plain text message string.

description: A Markdown message string.

description: The identifier for this message.

description: An array of strings to substitute into the message string.

description: Key/value pairs that provide additional information about the message.

description: A message string or message format string rendered in multiple formats.

description: A plain text message string or format string.

description: A Markdown message string or format string.

description: Represents a node in a graph.

description: A string that uniquely identifies the node within its graph.

description: A short description of the node.

description: A code location associated with the node.

description: Array of child nodes.

description: Key/value pairs that provide additional information about the node.

description: Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.

description: The locations relevant to this notification.

description: A message that describes the condition that was encountered.

description: A value specifying the severity level of the notification.

description: The thread identifier of the code that generated the notification.

description: The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.

description: The runtime exception, if any, relevant to this notification.

description: A reference used to locate the descriptor relevant to this notification.

description: A reference used to locate the rule descriptor associated with this notification.

description: Key/value pairs that provide additional information about the notification.

description: A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.

description: The address of the location.

description: The location of the artifact.

description: Specifies a portion of the artifact.

description: Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region.

description: Key/value pairs that provide additional information about the physical location.

description: Key/value pairs that provide additional information about the object.

description: A set of distinct strings that provide additional information.

description: An area within an image.

description: The Y coordinate of the top edge of the rectangle, measured in the image's natural units.

description: The X coordinate of the left edge of the rectangle, measured in the image's natural units.

description: The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.

description: The X coordinate of the right edge of the rectangle, measured in the image's natural units.

description: A message relevant to the rectangle.

description: Key/value pairs that provide additional information about the rectangle.

description: A region within an artifact where a result was detected.

description: The line number of the first character in the region.

description: The column number of the first character in the region.

description: The line number of the last character in the region.

description: The column number of the character following the end of the region.

description: The zero-based offset from the beginning of the artifact of the first character in the region.

description: The length of the region in characters.

description: The zero-based offset from the beginning of the artifact of the first byte in the region.

description: The length of the region in bytes.

description: The portion of the artifact contents within the specified region.

description: A message relevant to the region.

description: Specifies the source language, if any, of the portion of the artifact specified by the region object.

description: Key/value pairs that provide additional information about the region.

description: The replacement of a single region of an artifact.

description: The region of the artifact to delete.

description: The content to insert at the location specified by the 'deletedRegion' property.

description: Key/value pairs that provide additional information about the replacement.

description: Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.

description: A stable, opaque identifier for the report.

description: An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.

description: A unique identifier for the reporting descriptor in the form of a GUID.

description: An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.

description: A report identifier that is understandable to an end user.

description: An array of readable identifiers by which this report was known in some previous version of the analysis tool.

description: A concise description of the report. Should be a single sentence that is understandable when visible space is limited to a single line of text.

description: A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.

description: A set of name/value pairs with arbitrary names. Each value is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

description: Default reporting configuration information.

description: A URI where the primary documentation for the report can be found.

description: Provides the primary documentation for the report, useful when there is no online documentation.

description: An array of objects that describe relationships between this reporting descriptor and others.

description: Key/value pairs that provide additional information about the report.

description: Information about a rule or notification that can be configured at runtime.

description: Specifies whether the report may be produced during the scan.

description: Specifies the failure level for the report.

description: Specifies the relative priority of the report. Used for analysis output only.

description: Contains configuration information specific to a report.

description: Key/value pairs that provide additional information about the reporting configuration.

description: Information about how to locate a relevant reporting descriptor.

description: The id of the descriptor.

description: The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.

description: A guid that uniquely identifies the descriptor.

description: A reference used to locate the toolComponent associated with the descriptor.

description: Key/value pairs that provide additional information about the reporting descriptor reference.

description: Information about the relation of one reporting descriptor to another.

description: A reference to the related reporting descriptor.

description: A set of distinct strings that categorize the relationship. Well-known kinds include 'canPrecede', 'canFollow', 'willPrecede', 'willFollow', 'superset', 'subset', 'equal', 'disjoint', 'relevant', and 'incomparable'.

description: A description of the reporting descriptor relationship.

description: A result produced by an analysis tool.

description: The stable, unique identifier of the rule, if any, to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists.

description: The index within the tool component rules array of the rule object associated with this result.

description: A reference used to locate the rule descriptor relevant to this result.

description: A value that categorizes results by evaluation state.

enum: notApplicable pass fail review open informational

description: A value specifying the severity level of the result.

description: A message that describes the result. The first sentence of the message only will be displayed when visible space is limited.

description: Identifies the artifact that the analysis tool was instructed to scan. This need not be the same as the artifact where the result actually occurred.

description: The set of locations where the result was detected. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.

description: A stable, unique identifier for the result in the form of a GUID.

description: A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.

description: A positive integer specifying the number of times this logically unique result was observed in this run.

description: A set of strings that contribute to the stable, unique identity of the result.

description: A set of strings each of which individually defines a stable, unique identity for the result.

description: An array of 'stack' objects relevant to the result.

description: An array of 'codeFlow' objects relevant to the result.

description: An array of zero or more unique graph objects associated with the result.

description: An array of one or more unique 'graphTraversal' objects.

description: A set of locations relevant to this result.

description: A set of suppressions relevant to this result.

description: The state of a result relative to a baseline of a previous run.

description: A number representing the priority or importance of the result.

description: A set of artifacts relevant to the result.

description: An absolute URI at which the result can be viewed.

description: The URIs of the work items associated with this result.

description: Information about how and when the result was detected.

description: An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.

description: An array of references to taxonomy reporting descriptors that are applicable to the result.

description: A web request associated with this result.

description: A web response associated with this result.

description: Key/value pairs that provide additional information about the result.

description: Contains information about how and when a result was detected.

description: The Coordinated Universal Time (UTC) date and time at which the result was first detected. See "Date/time properties" in the SARIF spec for the required format.

description: The Coordinated Universal Time (UTC) date and time at which the result was most recently detected. See "Date/time properties" in the SARIF spec for the required format.

description: A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.

description: A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.

description: The index within the run.invocations array of the invocation object which describes the tool invocation that detected the result.

description: An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result.

description: Describes a single run of an analysis tool, and contains the reported output of that run.

description: Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.

description: Describes the invocation of the analysis tool.

description: A conversion object that describes how a converter transformed an analysis tool's native reporting format into the SARIF format.

description: The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

description: Specifies the revision in version control of the artifacts that were scanned.

description: The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.

description: An array of artifact objects relevant to the run.

description: An array of logical locations such as namespaces, types or functions.

description: An array of zero or more unique graph objects associated with the run.

description: The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.

description: Automation details that describe this run.

description: Automation details that describe the aggregate of runs to which this run belongs.

description: The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.

description: An array of strings used to replace sensitive information in a redaction-aware property.

description: Specifies the default encoding for any artifact object that refers to a text file.

description: Specifies the default source language for any artifact object that refers to a text file that contains source code.

description: An ordered list of character sequences that were treated as line breaks when computing region information for the run.

description: Specifies the unit in which the tool measures columns.

description: An array of threadFlowLocation objects cached at run level.

description: An array of toolComponent objects relevant to a taxonomy in which results are categorized.

description: Addresses associated with this run instance, if any.

description: The set of available translations of the localized data provided by the tool.

description: Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).

description: An array of request objects cached at run level.

description: An array of response objects cached at run level.

description: A specialLocations object that defines locations of special significance to SARIF consumers.

description: Key/value pairs that provide additional information about the run.

description: Information that describes a run's identity and role within an engineering system process.

description: A description of the identity and role played within the engineering system by this object's containing run object.

description: A hierarchical string that uniquely identifies this object's containing run object.

description: A stable, unique identifier for this object's containing run object in the form of a GUID.

description: A stable, unique identifier for the equivalence class of runs to which this object's containing run object belongs in the form of a GUID.

description: Key/value pairs that provide additional information about the run automation details.

description: Defines locations of special significance to SARIF consumers.

description: Provides a suggestion to SARIF consumers to display file paths relative to the specified location.

description: Key/value pairs that provide additional information about the special locations.

description: A call stack that is relevant to a result.

description: A message relevant to this call stack.

description: An array of stack frames that represents a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

description: Key/value pairs that provide additional information about the stack.

description: A function call within a stack trace.

description: The location to which this stack frame refers.

description: The name of the module that contains the code of this stack frame.

description: The thread identifier of the stack frame.

description: The parameters of the call that is executing.

description: Key/value pairs that provide additional information about the stack frame.

description: A suppression that is relevant to a result.

description: A stable, unique identifier for the suppression in the form of a GUID.

description: A string that indicates where the suppression is persisted.

description: A string that indicates the state of the suppression.

description: A string representing the justification for the suppression.

description: Identifies the location associated with the suppression.

description: Key/value pairs that provide additional information about the suppression.

description: An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.

description: A message relevant to the thread flow.

description: Values of relevant expressions at the start of the thread flow that may change during thread flow execution.

description: Values of relevant expressions at the start of the thread flow that remain constant.

description: A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.

description: Key/value pairs that provide additional information about the thread flow.

description: A location visited by an analysis tool while simulating or monitoring the execution of a program.

description: The index within the run threadFlowLocations array.

description: The code location.

description: The call stack leading to this location.

description: A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.

description: An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.

description: The name of the module that contains the code that is executing.

description: A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.

description: An integer representing a containment hierarchy within the thread flow.

description: An integer representing the temporal order in which execution reached this location.

description: The Coordinated Universal Time (UTC) date and time at which this location was executed.

description: Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is "essential", "important", "unimportant". Default: "important".

description: A web request associated with this thread flow location.

description: A web response associated with this thread flow location.

description: Key/value pairs that provide additional information about the threadflow location.

description: The analysis tool that was run.

description: The analysis tool that was run.

description: Tool extensions that contributed to or reconfigured the analysis tool that was run.

description: Key/value pairs that provide additional information about the tool.

description: A component, such as a plug-in or the driver, of the analysis tool that was run.

description: A unique identifier for the tool component in the form of a GUID.

description: The name of the tool component.

description: The organization or company that produced the tool component.

description: A product suite to which the tool component belongs.

description: A localizable string containing the name of the suite of products to which the tool component belongs.

description: A brief description of the tool component.

description: A comprehensive description of the tool component.

description: The name of the tool component along with its version and any other useful identifying information, such as its locale.

description: The tool component version, in whatever format the component natively provides.

description: The tool component version in the format specified by Semantic Versioning 2.0.

description: The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).

description: A string specifying the UTC date (and optionally, the time) of the component's release.

description: The absolute URI from which the tool component can be downloaded.

description: The absolute URI at which information about this version of the tool component can be found.

description: A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

description: An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.

description: An array of reportingDescriptor objects relevant to the analysis performed by the tool component.

description: An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.

description: An array of the artifactLocation objects associated with the tool component.

description: The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).

description: The kinds of data contained in this object.

description: Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.

description: The semantic version of the localized strings defined in this component; maintained by components that provide translations.

description: The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.

description: The component which is strongly associated with this component. For a translation, this refers to the component which has been translated. For an extension, this is the driver that provides the extension's plugin model.

description: Translation metadata, required for a translation, not populated by other component types.

description: An array of toolComponentReference objects to declare the taxonomies supported by the tool component.

description: Key/value pairs that provide additional information about the tool component.

description: The 'name' property of the referenced toolComponent.

description: An index into the referenced toolComponent in tool.extensions.

description: The 'guid' property of the referenced toolComponent.

description: Key/value pairs that provide additional information about the toolComponentReference.

description: Provides additional metadata related to translation.

description: The name associated with the translation metadata.

description: The full name associated with the translation metadata.

description: A brief description of the translation metadata.

description: A comprehensive description of the translation metadata.

description: The absolute URI from which the translation metadata can be downloaded.

description: The absolute URI from which information related to the translation metadata can be downloaded.

description: Key/value pairs that provide additional information about the translation metadata.

description: Specifies the information necessary to retrieve a desired revision from a version control system.

description: The absolute URI of the repository.

description: A string that uniquely and permanently identifies the revision within the repository.

description: The name of a branch containing the revision.

description: A tag that has been applied to the revision.

description: A Coordinated Universal Time (UTC) date and time that can be used to synchronize an enlistment to the state of the repository at that time.

description: The location in the local file system to which the root of the repository was mapped at the time of the analysis.

description: Key/value pairs that provide additional information about the version control details.

description: A web request object.

description: The index within the run.webRequests array of the request object associated with this result.

description: The request protocol. Example: 'http'.

description: The request version. Example: '1.1'.

description: The target of the request.

description: The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.

description: The request headers.

description: The request parameters.

description: The body of the request.

description: Key/value pairs that provide additional information about the request.

description: A web response object.

description: The index within the run.webResponses array of the response object associated with this result.

description: The response protocol. Example: 'http'.

description: The response version. Example: '1.1'.

description: The response status code. Example: 451.

description: The response reason. Example: 'Not found'.

description: The response headers.

description: The body of the response.

description: Specifies whether a response was received from the server.

description: Key/value pairs that provide additional information about the response.

description: Static Analysis Results Format (SARIF) Version 2.1.0-rtm.2 JSON Schema: a standard format for the output of static analysis tools.

description: The URI of the JSON schema corresponding to the version.

description: The SARIF format version of this log file.

description: The set of runs contained in this log file.

description: References to external property files that share data between runs.

description: Key/value pairs that provide additional information about the log file.

title: Static Analysis Results Format (SARIF) Version 2.1.0-rtm.2 JSON Schema


electron-builder.json

description: The [artifact file name template](/configuration/configuration#artifact-file-name-template).

description: The [application category](https://specifications.freedesktop.org/menu-spec/latest/apa.html#main-category-registry).

description: As [description](/configuration/configuration#Metadata-description) from application package.json, but allows you to specify different for Linux.

description: The [Desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) entries (name to value).

description: The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). Only plain text is supported.

type: string

type: array

description: The mime types in addition to specified in the file associations. Use it if you don't want to register a new mime type, but reuse existing.

$ref: #/definitions/GithubOptions

$ref: #/definitions/SpacesOptions

$ref: #/definitions/GenericServerOptions

$ref: #/definitions/BintrayOptions

$ref: #/definitions/CustomPublishOptions

description: The [short description](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Description).

default: ask

description: The system integration installation.

enum: ask doNotAsk

title: AppImageOptions

type: object

description: Whether to add auto launch extension. Defaults to `true` if [electron-winstore-auto-launch](https://github.com/felixrieseberg/electron-winstore-auto-launch) in the dependencies.

type: boolean

description: The application id. Defaults to `identityName`. Can't start with numbers.

description: The background color of the app tile. See [Visual Elements](https://msdn.microsoft.com/en-us/library/windows/apps/br211471.aspx).

description:
A friendly name that can be displayed to users. Corresponds to [Properties.DisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211432.aspx).
Defaults to the application product name.

description: The name. Corresponds to [Identity.Name](https://msdn.microsoft.com/en-us/library/windows/apps/br211441.aspx). Defaults to the [application name](/configuration/configuration#Metadata-name).

description:
The list of [supported languages](https://docs.microsoft.com/en-us/windows/uwp/globalizing/manage-language-and-region#specify-the-supported-languages-in-the-apps-manifest) that will be listed in the Windows Store.
The first entry (index 0) will be the default language.
Defaults to en-US if omitted.

description: The Windows Store publisher. Not used if AppX is build for testing. See [AppX Package Code Signing](#appx-package-code-signing) below.

description:
A friendly name for the publisher that can be displayed to users. Corresponds to [Properties.PublisherDisplayName](https://msdn.microsoft.com/en-us/library/windows/apps/br211460.aspx).
Defaults to company name from the application metadata.

description: Whether to overlay the app's name on top of tile images on the Start screen. Defaults to `false`. (https://docs.microsoft.com/en-us/uwp/schemas/appxpackage/uapmanifestschema/element-uap-shownameontiles) in the dependencies.

description: Whether to set build number. See https://github.com/electron-userland/electron-builder/issues/3875

title: AppXOptions

description: Allows external asar files.

description: Whether to automatically unpack executables files.

title: AsarOptions

description:
[Bintray](https://bintray.com/) options. Requires an API key. An API key can be obtained from the user [profile](https://bintray.com/profile/edit) page ("Edit Your Profile" -> API Key).
Define `BT_TOKEN` environment variable.

description: The Bintray component (Debian only).

default: stable

description: The Bintray distribution (Debian only).

description: The owner.

description: The Bintray package name.

description: The provider. Must be `bintray`.

description:
Whether to publish auto update info files.

Auto update relies only on the first provider in the list (you can specify several publishers).
Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.

default: generic

description: The Bintray repository name.

description: The Bintray user account. Used in cases where the owner is an organization.

title: BintrayOptions

$ref: #/definitions/PublishProvider

description: The provider.

title: CustomPublishOptions

enum: bzip2 gz xz

default: xz

description: The compression type.

description: Package dependencies. Defaults to `["gconf2", "gconf-service", "libnotify4", "libappindicator1", "libxtst6", "libnss3"]`.

description:
*Advanced only* The [fpm](https://github.com/jordansissel/fpm/wiki#usage) options.

Example: `["--before-install=build/deb-preinstall.sh", "--after-upgrade=build/deb-postinstall.sh"]`

description: The [package category](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Section).

description: The [Priority](https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Priority) attribute.

title: DebOptions

description: The name of the file within the DMG. Defaults to basename of `path`.

description: The path of the file within the DMG.

enum: dir file link

type: number

required: x y

title: DmgContent

description:
The path to background image (default: `build/background.tiff` or `build/background.png` if exists). The resolution of this file determines the resolution of the installer window.
If background is not specified, use `window.size`. Default locations expected background size to be 540x380.

description: The background color (accepts css colors). Defaults to `#ffffff` (white) if no background image.

description: The content — to customize icon locations.

$ref: #/definitions/DmgContent

default: UDZO

description: The disk image format. `ULFO` (lzfse-compressed image (OS X 10.11+ only)).

enum: UDBZ UDCO UDRO UDRW UDZO ULFO

description:
The path to DMG icon (volume icon), which will be shown when mounted, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to the application icon (`build/icon.icns`).

description: The size of all the icons inside the DMG.

description: The size of all the icon texts inside the DMG.

description: Whether to create internet-enabled disk image (when it is downloaded using a browser it will automatically decompress the image, put the application on the desktop, unmount and remove the disk image file).

description:
The title of the produced DMG, which will be shown when mounted (volume name).

Macro `${productName}`, `${version}` and `${name}` are supported.

description: The DMG windows position and size.

title: DmgOptions

description: The height. Defaults to background image height or 380.

description: The width. Defaults to background image width or 540.

description: The X position relative to left of the screen.

description: The Y position relative to top of the screen.

title: DmgWindow

description: The [cache location](https://github.com/electron-userland/electron-download#cache-location).

description: The mirror.

title: ElectronDownloadOptions

description:
File associations.

macOS (corresponds to [CFBundleDocumentTypes](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-101685)) and NSIS only.

On Windows works only if [nsis.perMachine](https://electron.build/configuration/configuration#NsisOptions-perMachine) is set to `true`.

description: *windows-only.* The description.

description: The extension (minus the leading period). e.g. `png`.

description:
The path to icon (`.icns` for MacOS and `.ico` for Windows), relative to `build` (build resources directory). Defaults to `${firstExt}.icns`/`${firstExt}.ico` (if several extensions specified, first is used) or to application icon.

Not supported on Linux, file issue if need (default icon will be `x-office-document`).

description: *macOS-only* Whether the document is distributed as a bundle. If set to true, the bundle directory is treated as a file. Corresponds to `LSTypeIsPackage`.

description: *linux-only.* The mime-type.

description: The name. e.g. `PNG`. Defaults to `ext`.

description: *macOS-only* The app's role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Corresponds to `CFBundleTypeRole`.

title: FileAssociation

description: The [glob patterns](/file-patterns).

description: The source path relative to the project directory.

description: The destination path relative to the app's content directory for `extraFiles` and the app's resource directory for `extraResources`.

title: FileSet

description:
Generic (any HTTP(S) server) options.
In all publish options [File Macros](/file-patterns#file-macros) are supported.

description: The channel.

description: The provider. Must be `generic`.

description: The base url. e.g. `https://bucket_name.s3.amazonaws.com`.

description: Whether to use multiple range requests for differential update. Defaults to `true` if `url` doesn't contain `s3.amazonaws.com`.

title: GenericServerOptions

description:
[GitHub](https://help.github.com/articles/about-releases/) options.

GitHub [personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) is required. You can generate by going to [https://github.com/settings/tokens/new](https://github.com/settings/tokens/new). The access token should have the repo scope/permission.
Define `GH_TOKEN` environment variable.

description: The host (including the port if need).

description: The owner.

description: Whether to use private github auto-update provider if `GH_TOKEN` environment variable is defined. See [Private GitHub Update Repo](/auto-update#private-github-update-repo).

description: The protocol. GitHub Publisher supports only `https`.

description: The provider. Must be `github`.

description:
The type of release. By default `draft` release will be created.

Also you can set release type using environment variable. If `EP_DRAFT`is set to `true` — `draft`, if `EP_PRE_RELEASE`is set to `true` — `prerelease`.

description: The repository name. [Detected automatically](#github-repository-and-bintray-package).

description: The access token to support auto-update from private github repositories. Never specify it in the configuration files. Only for [setFeedURL](/auto-update#appupdatersetfeedurloptions).

description: Whether to use `v`-prefixed tag name.

title: GithubOptions

description:
The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as
[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.

description: The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName}-${version}.${ext}` (some target can have other defaults, see corresponding options).

description:
Whether to package the application's source code into an archive, using [Electron's archive format](http://electron.atom.io/docs/tutorial/application-packaging/).

Node modules, that must be unpacked, will be detected automatically, you don't need to explicitly set [asarUnpack](#configuration-asarUnpack) - please file an issue if this doesn't work.

description: A [glob patterns](/file-patterns) relative to the [app directory](#MetadataDirectories-app), which specifies which files to unpack when creating the [asar](http://electron.atom.io/docs/tutorial/application-packaging/) archive.

description: The compression level. If you want to rapidly test build, `store` can reduce build time significantly. `maximum` doesn't lead to noticeable size difference, but increase build time.

description: Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.

description: The [electron-updater compatibility](/auto-update#compatibility) semver range.

description:
The executable name. Defaults to `productName`.
Cannot be specified per target, allowed only in the `linux`.

description: The file associations.

description: Whether to fail if app will be not code signed.

description: Please see [Building and Releasing using Channels](https://github.com/electron-userland/electron-builder/issues/1182#issuecomment-324947139).

description:
The path to icon set directory or one png file, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory. The icon filename must contain the size (e.g. 32x32.png) of the icon.
By default will be generated automatically based on the macOS icns file.

description: The maintainer. Defaults to [author](/configuration/configuration#Metadata-author).

description: backward compatibility + to allow specify fpm-only category for all possible fpm targets in one place

description: The URL protocol schemes.

description:
The release info. Intended for command line usage:

```
-c.releaseInfo.releaseNotes="new features"
```

description:
Target package type: list of `AppImage`, `snap`, `deb`, `rpm`, `freebsd`, `pacman`, `p5p`, `apk`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`.

electron-builder [docker image](/multi-platform-build#docker) can be used to build Linux targets on any platform.

Please [do not put an AppImage into another archive](https://github.com/probonopd/AppImageKit/wiki/Creating-AppImages#common-mistake) like a .zip or .tar.gz.

description: The vendor. Defaults to [author](/configuration/configuration#Metadata-author).

title: LinuxConfiguration

description: The compression type.

description: Package dependencies.

description: The package category.

title: LinuxTargetSpecificOptions

description: Paths of any extra binaries that need to be signed.

description: The `CFBundleShortVersionString`. Do not use it unless you need to.

description: The `CFBundleVersion`. Do not use it unless [you need to](https://github.com/electron-userland/electron-builder/issues/565#issuecomment-230678643).

description:
The application category type, as shown in the Finder via *View -> Arrange by Application Category* when viewing the Applications directory.

For example, `"category": "public.app-category.developer-tools"` will set the application category to *Developer Tools*.

Valid values are listed in [Apple's documentation](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/uid/TP40009250-SW8).

description: Whether a dark mode is supported. If your app does have a dark mode, you can make your app follow the system-wide dark mode setting.

description: Whether your app has to be signed with hardened runtime.

description: Whether to let electron-osx-sign validate the signing or not.

description: The electron locales. By default Electron locales used as is.

description:
The path to entitlements file for signing the app. `build/entitlements.mac.plist` will be used if exists (it is a recommended way to set).
MAS entitlements is specified in the [mas](/configuration/mas).

description:
The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mac.inherit.plist` will be used if exists (it is a recommended way to set).
Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.darwin.inherit.plist).

This option only applies when signing with `entitlements` provided.

description: The extra entries for `Info.plist`.

description: Extra files to put in archive. Not applicable for `tar.*`.

description: The file associations.

description: The bundle identifier to use in the application helper's plist.

description: The path to application icon.

description:
The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](/code-signing) instead of specifying this option.
MAS installer identity is specified in the [mas](/configuration/mas).

description: The minimum version of macOS required for the app to run. Corresponds to `LSMinimumSystemVersion`.

description: The URL protocol schemes.

description: The path to the provisioning profile to use when signing, absolute or relative to the app root.

description: Path of [requirements file](https://developer.apple.com/library/mac/documentation/Security/Conceptual/CodeSigningGuide/RequirementLang/RequirementLang.html) used in signing. Not applicable for MAS.

description: The target package type: list of `default`, `dmg`, `mas`, `mas-dev`, `pkg`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`. Defaults to `default` (dmg and zip for Squirrel.Mac).

description: Whether to sign app for development or for distribution.

title: MacConfiguration

description:
The path to entitlements file for signing the app. `build/entitlements.mas.plist` will be used if exists (it is a recommended way to set).
Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.plist).

description:
The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mas.inherit.plist` will be used if exists (it is a recommended way to set).
Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.inherit.plist).

description: The extra entries for `Info.plist`.

description: The file associations.

description: The path to application icon.

description: The URL protocol schemes.

title: MasConfiguration

description: The application directory (containing the application package.json), defaults to `app`, `www` or working directory.

description:
The path to build resources.

Please note — build resources is not packed into the app. If you need to use some files, e.g. as tray icon, please include required files explicitly: `"files": ["**\/*", "build/icon.*"]`

description: The output directory. [File macros](/file-patterns#file-macros) are supported.

title: MetadataDirectories

description: Whether to create desktop shortcut. Set to `always` if to recreate also on reinstall (even if removed by user).

description: Whether to create start menu shortcut.

description: Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value.

description: One-click installation.

description: Whether to install per all users (per-machine).

description: Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed.

description: The name that will be used for all shortcuts. Defaults to the application name.

description: The [upgrade code](https://msdn.microsoft.com/en-us/library/windows/desktop/aa372375(v=vs.85).aspx). Optional, by default generated using app id.

description: If `warningsAsErrors` is `true` (default): treat warnings as errors. If `warningsAsErrors` is `false`: allow warnings.

title: MsiOptions

description: *assisted installer only.* Allow requesting for elevation. If false, user will have to restart installer with elevated permissions.

description: *assisted installer only.* Whether to allow user to change installation directory.

description: The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName} Setup ${version}.${ext}`.

description: Whether to create start menu shortcut.

description: *one-click installer only.* Whether to delete app data on uninstall.

description: Defaults to `true` for web installer (`nsis-web`)

description: Whether to display a language selection dialog. Not recommended (by default will be detected using OS language).

description: See [GUID vs Application Name](../configuration/nsis#guid-vs-application-name).

description: The path to NSIS include script to customize installer. Defaults to `build/installer.nsh`. See [Custom NSIS script](#custom-nsis-script).

description: *assisted installer only.* `MUI_HEADERIMAGE`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.

description:
*one-click installer only.* The path to header icon (above the progress bar), relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `build/installerHeaderIcon.ico` or application icon.

description:
The path to installer icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `build/installerIcon.ico` or application icon.

description: The installer languages (e.g. `en_US`, `de_DE`). Change only if you understand what do you do and for what.

description:
*assisted installer only.* `MUI_WELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `build/installerSidebar.bmp` or `${NSISDIR}\\Contrib\\Graphics\\Wizard\\nsis3-metro.bmp`. Image size 164 × 314 pixels.

description: [LCID Dec](https://msdn.microsoft.com/en-au/goglobal/bb964664.aspx), defaults to `1033`(`English - United States`).

description:
The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). In addition to `txt, `rtf` and `html` supported (don't forget to use `target="_blank"` for links).

Multiple license files in different languages are supported — use lang postfix (e.g. `_de`, `_ru`)). For example, create files `license_de.txt` and `license_en.txt` in the build resources.
If OS language is german, `license_de.txt` will be displayed. See map of [language code to name](https://github.com/meikidd/iso-639-1/blob/master/src/data.js).

Appropriate license file will be selected by user OS language.

description: Whether to create multi-language installer. Defaults to `unicode` option value.

description: Whether to create one-click installer or assisted.

description: Whether to pack the elevate executable (required for electron-updater if per-machine installer used or can be used in the future). Ignored if `perMachine` is set to `true`.

description:
Whether to show install mode installer page (choice per-machine or per-user) for assisted installer. Or whether installation always per all users (per-machine).

If `oneClick` is `true` (default): Whether to install per all users (per-machine).

If `oneClick` is `false` and `perMachine` is `true`: no install mode installer page, always install per-machine.

If `oneClick` is `false` and `perMachine` is `false` (default): install mode installer page.

default: .avi .mov .m4v .mp4 .m4p .qt .mkv .webm .vmdk

description: The file extension of files that will be not compressed. Applicable only for `extraResources` and `extraFiles` files.

description: The path to NSIS script to customize installer. Defaults to `build/installer.nsi`. See [Custom NSIS script](#custom-nsis-script).

description: Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode).

description: The uninstaller display name in the control panel.

description:
The path to uninstaller icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `build/uninstallerIcon.ico` or application icon.

description:
*assisted installer only.* `MUI_UNWELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `installerSidebar` option or `build/uninstallerSidebar.bmp` or `build/installerSidebar.bmp` or `${NSISDIR}\\Contrib\\Graphics\\Wizard\\nsis3-metro.bmp`

description: If `warningsAsErrors` is `true` (default): NSIS will treat warnings as errors. If `warningsAsErrors` is `false`: NSIS will allow warnings.

title: NsisOptions

description: Web Installer options.

description:
The application package download URL. Optional — by default computed using publish configuration.

URL like `https://example.com/download/latest` allows web installer to be version independent (installer will download latest application package).
Please note — it is [full URL](https://github.com/electron-userland/electron-builder/issues/1810#issuecomment-317650878).

Custom `X-Arch` http header is set to `32` or `64`.

description: The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName} Web Setup ${version}.${ext}`.

description: Whether to create start menu shortcut.

title: NsisWebOptions

description: Options for the background image in a PKG installer

enum: bottom bottomleft bottomright center left right top topleft topright

description:
Alignment of the background image.
Options are: center, left, right, top, bottom, topleft, topright, bottomleft, bottomright

description: Path to the image to use as an installer background.

description:
Scaling of the background image.
Options are: tofit, none, proportional

title: PkgBackgroundOptions

description: macOS product archive options.

description:
Whether can be installed at the root of any volume, including non-system volumes. Otherwise, it cannot be installed at the root of a volume.

Corresponds to [enable_anywhere](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).

description:
Whether can be installed into the current user's home directory.
A home directory installation is done as the current user (not as root), and it cannot write outside of the home directory.
If the product cannot be installed in the user's home directory and be not completely functional from user's home directory.

Corresponds to [enable_currentUserHome](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).

description:
Whether can be installed into the root directory. Should usually be `true` unless the product can be installed only to the user's home directory.

Corresponds to [enable_localSystem](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70).

description: Options for the background image for the installer.

description: The path to the conclusion file. This may be used to customize the text on the final "Summary" page of the installer.

description: Require identical bundle identifiers at install path?

description: The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](/code-signing) instead of specifying this option.

description:
The install location. [Do not use it](https://stackoverflow.com/questions/12863944/how-do-you-specify-a-default-install-location-to-home-with-pkgbuild) to create per-user package.
Mostly never you will need to change this option. `/Applications` would install it as expected into `/Applications` if the local system domain is chosen, or into `$HOME/Applications` if the home installation is chosen.

description: Install bundle over previous version if moved by user?

description: Don't install bundle if newer version on disk?

description:
Specifies how an existing version of the bundle on disk should be handled when the version in
the package is installed.

If you specify upgrade, the bundle in the package atomi-cally replaces any version on disk;
this has the effect of deleting old paths that no longer exist in the new version of
the bundle.

If you specify update, the bundle in the package overwrites the version on disk, and any files
not contained in the package will be left intact; this is appropriate when you are delivering
an update-only package.

Another effect of update is that the package bundle will not be installed at all if there is
not already a version on disk; this allows a package to deliver an update for an app that
the user might have deleted.

description: should be not documented, only to experiment

description:
The scripts directory, relative to `build` (build resources directory).
The scripts can be in any language so long as the files are marked executable and have the appropriate shebang indicating the path to the interpreter.
Scripts are required to be executable (`chmod +x file`).

description: The path to the welcome file. This may be used to customize the text on the Introduction page of the installer.

title: PkgOptions

title: PlugDescriptor

description: Portable options.

description: The [requested execution level](http://nsis.sourceforge.net/Reference/RequestExecutionLevel) for Windows.

description:
The unpack directory name in [TEMP](https://www.askvg.com/where-does-windows-store-temporary-files-and-how-to-change-temp-folder-location/) directory.

Defaults to [uuid](https://github.com/segmentio/ksuid) of build (changed on each build of portable executable).

title: PortableOptions

description:
URL Protocol Schemes. Protocols to associate the app with. macOS only.

Please note — on macOS [you need to register an `open-url` event handler](http://electron.atom.io/docs/api/app/#event-open-url-macos).

description: The name. e.g. `IRC server URL`.

description: *macOS-only* The app's role with respect to the type.

description: The schemes. e.g. `["irc", "ircs"]`.

title: Protocol

title: PublishProvider

description: The release date.

description: The release name.

description: The release notes.

description: The path to release notes file. Defaults to `release-notes-${platform}.md` (where `platform` it is current platform — `mac`, `linux` or `windows`) or `release-notes.md` in the [build resources](#MetadataDirectories-buildResources).

title: ReleaseInfo

description:
The ACL. Set to `null` to not [add](https://github.com/electron-userland/electron-builder/issues/1822).

Please see [required permissions for the S3 provider](https://github.com/electron-userland/electron-builder/issues/1618#issuecomment-314679128).

description: The bucket name.

description: The update channel.

description: Server-side encryption algorithm to use for the object.

description:
The endpoint URI to send requests to. The default endpoint is built from the configured region.
The endpoint should be a string like `https://{service}.{region}.amazonaws.com`.

description: The directory path.

description: The provider. Must be `s3`.

description: The region. Is determined and set automatically when publishing.

description: The type of storage to use for the object.

title: S3Options

description:
Specifies any [parts](https://snapcraft.io/docs/reference/parts) that should be built before this part.
Defaults to `["desktop-gtk2""]`.

If list contains `default`, it will be replaced to default list, so, `["default", "foo"]` can be used to add custom parts `foo` in addition to defaults.

description: The list of features that must be supported by the core in order for this snap to install.

description: The list of debian packages needs to be installed for building this snap.

description: The type of [confinement](https://snapcraft.io/docs/reference/confinement) supported by the snap.

description: The custom environment. Defaults to `{"TMPDIR: "$XDG_RUNTIME_DIR"}`. If you set custom, it will be merged with default.

description: The quality grade of the snap. It can be either `devel` (i.e. a development version of the snap, so not to be published to the "stable" or "candidate" channels) or "stable" (i.e. a stable release or release candidate, which can be released to all channels).

description: The [hooks](https://docs.snapcraft.io/build-snaps/hooks) directory, relative to `build` (build resources directory).

description:
The list of [plugs](https://snapcraft.io/docs/reference/interfaces).
Defaults to `["desktop", "desktop-legacy", "home", "x11", "unity7", "browser-support", "network", "gsettings", "pulseaudio", "opengl"]`.

If list contains `default`, it will be replaced to default list, so, `["default", "foo"]` can be used to add custom plug `foo` in addition to defaults.

Additional attributes can be specified using object instead of just name of plug:
```
[
  {
    "browser-sandbox": {
      "interface": "browser-support",
      "allow-sandbox": true
    },
  },
  "another-simple-plug-name"
]
```

description:
The list of Ubuntu packages to use that are needed to support the `app` part creation. Like `depends` for `deb`.
Defaults to `["libasound2", "libgconf2-4", "libnotify4", "libnspr4", "libnss3", "libpcre3", "libpulse0", "libxss1", "libxtst6"]`.

If list contains `default`, it will be replaced to default list, so, `["default", "foo"]` can be used to add custom package `foo` in addition to defaults.

description: The 78 character long summary. Defaults to [productName](/configuration/configuration#Configuration-productName).

description: Whether to use template snap. Defaults to `true` if `stagePackages` not specified.

title: SnapOptions

description:
[DigitalOcean Spaces](https://www.digitalocean.com/community/tutorials/an-introduction-to-digitalocean-spaces) options.
Access key is required, define `DO_KEY_ID` and `DO_SECRET_KEY` environment variables.

description: The ACL. Set to `null` to not [add](https://github.com/electron-userland/electron-builder/issues/1822).

description: The update channel.

description: The space name.

description: The directory path.

description: The provider. Must be `spaces`.

description: The region (e.g. `nyc3`).

title: SpacesOptions

description:
A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Electron icon.

Please note — [local icon file url is not accepted](https://github.com/atom/grunt-electron-installer/issues/73), must be https/http.

If you don't plan to build windows installer, you can omit it.
If your project repository is public on GitHub, it will be `https://github.com/${u}/${p}/blob/master/build/icon.ico?raw=true` by default.

description:
The path to a .gif file to display during install. `build/install-spinner.gif` will be used if exists (it is a recommended way to set)
(otherwise [default](https://github.com/electron/windows-installer/blob/master/resources/install-spinner.gif)).

description: Whether to create an MSI installer. Defaults to `false` (MSI is not created).

description: A URL to your existing updates. Or `true` to automatically set to your GitHub repository. If given, these will be downloaded to create delta updates.

description: Authentication token for remote updates

description: Use `appId` to identify package instead of `name`.

title: SquirrelWindowsOptions

description: The arch or list of archs.

description: The target name. e.g. `snap`.

title: TargetConfiguration

description: The path to an additional certificate file you want to add to the signature block.

description:
The path to the *.pfx certificate you want to sign with. Please use it only if you cannot use env variable `CSC_LINK` (`WIN_CSC_LINK`) for some reason.
Please see [Code Signing](/code-signing).

description:
The password to the certificate provided in `certificateFile`. Please use it only if you cannot use env variable `CSC_KEY_PASSWORD` (`WIN_CSC_KEY_PASSWORD`) for some reason.
Please see [Code Signing](/code-signing).

description: The SHA1 hash of the signing certificate. The SHA1 hash is commonly specified when multiple certificates satisfy the criteria specified by the remaining switches. Works only on Windows (or on macOS if [Parallels Desktop](https://www.parallels.com/products/desktop/) Windows 10 virtual machines exits).

description: The name of the subject of the signing certificate. Required only for EV Code Signing and works only on Windows (or on macOS if [Parallels Desktop](https://www.parallels.com/products/desktop/) Windows 10 virtual machines exits).

description: The file associations.

description: The path to application icon.

description: The trademarks and registered trademarks.

description: The URL protocol schemes.

description:
[The publisher name](https://github.com/electron-userland/electron-builder/issues/1187#issuecomment-278972073), exactly as in your code signed certificate. Several names can be provided.
Defaults to common name from your code signing certificate.

description:
The [security level](https://msdn.microsoft.com/en-us/library/6ad1fshk.aspx#Anchor_9) at which the application requests to be executed.
Cannot be specified per target, allowed only in the `win`.

description: The URL of the RFC 3161 time stamp server.

description: The custom function (or path to file or module id) to sign Windows executable.

description: Whether to sign and add metadata to executable. Advanced option.

description: Whether to sign DLL files. Advanced option.

description: Array of signing algorithms used. For AppX `sha256` is always used.

description:
The target package type: list of `nsis`, `nsis-web` (Web installer), `portable` ([portable](/configuration/nsis#portable) app without installation), `appx`, `msi`, `squirrel`, `7z`, `zip`, `tar.xz`, `tar.lz`, `tar.gz`, `tar.bz2`, `dir`.
AppX package can be built only on Windows 10.

To use Squirrel.Windows please install `electron-builder-squirrel-windows` dependency.

description: The URL of the time stamp server.

description:
Whether to verify the signature of an available update before installation.
The [publisher name](#publisherName) will be used for the signature verification.

title: WindowsConfiguration

description: Configuration Options

description: JSON Schema for this document.

description: The function (or path to file or module id) to be [run after all artifacts are build](#afterAllArtifactBuild).

description: The function (or path to file or module id) to be [run after pack](#afterpack) (but before pack into distributable format and sign).

description: The function (or path to file or module id) to be [run after pack and sign](#aftersign) (but before pack into distributable format).

description: AppImage options.

description: The function (or path to file or module id) to be run on artifact build completed.

description: The function (or path to file or module id) to be run on artifact build start.

description:
The function (or path to file or module id) to be run before dependencies are installed or rebuilt. Works when `npmRebuild` is set to `true`. Resolving to `false` will skip dependencies install or rebuild.

If provided and `node_modules` are missing, it will not invoke production dependencies check.

description: Whether to build the application native dependencies from source.

description:
The build version. Maps to the `CFBundleVersion` on macOS, and `FileVersion` metadata property on Windows. Defaults to the `version`.
If `TRAVIS_BUILD_NUMBER` or `APPVEYOR_BUILD_NUMBER` or `CIRCLE_BUILD_NUM` or `BUILD_NUMBER` or `bamboo.buildNumber` env defined, it will be used as a build version (`version.build_number`).

description: The human-readable copyright line for the app.

description: Debian package options.

description: macOS DMG options.

description: Whether to use [electron-compile](http://github.com/electron/electron-compile) to compile app. Defaults to `true` if `electron-compile` in the dependencies. And `false` if in the `devDependencies` or doesn't specified.

description: The path to custom Electron build (e.g. `~/electron/out/R`).

description: The [electron-download](https://github.com/electron-userland/electron-download#usage) options.

description: The version of electron you are packaging for. Defaults to version of `electron`, `electron-prebuilt` or `electron-prebuilt-compile` dependency.

description:
The name of a built-in configuration preset or path to config file (relative to project dir). Currently, only `react-cra` is supported.

If `react-scripts` in the app dependencies, `react-cra` will be set automatically. Set to `null` to disable automatic detection.

description: Inject properties to `package.json`.

description: The file associations.

description: The framework name. One of `electron`, `proton-native`, `libui`. Defaults to `electron`.

description: Whether to include PDB files.

description: *libui-based frameworks only* The version of LaunchUI you are packaging for. Applicable for Windows only. Defaults to version suitable for used framework version.

description: Options related to how build Linux targets.

description: Options related to how build macOS targets.

description: MAS (Mac Application Store) options.

description: The version of muon you are packaging for.

description:
Whether to execute `node-gyp rebuild` before starting to package the app.

Don't [use](https://github.com/electron-userland/electron-builder/issues/683#issuecomment-241214075) [npm](http://electron.atom.io/docs/tutorial/using-native-node-modules/#using-npm) (neither `.npmrc`) for configuring electron headers. Use `electron-builder node-gyp-rebuild` instead.

description:
*libui-based frameworks only* The version of NodeJS you are packaging for.
You can set it to `current` to set the Node.js version that you use to run.

description: Additional command line arguments to use when installing app native deps.

description: Whether to [rebuild](https://docs.npmjs.com/cli/rebuild) native dependencies before starting to package the app.

description: The function (or path to file or module id) to be [run on each node module](#onnodemodulefile) file.

description: macOS PKG options.

description: As [name](#Metadata-name), but allows you to specify a product name for your executable which contains spaces and other special characters not allowed in the [name property](https://docs.npmjs.com/files/package.json#name).

description: The URL protocol schemes.

description: Whether to fail if the application is not signed (to prevent unsigned app if code signing configuration is not correct).

description: Whether to build using Electron Build Service if target not supported on current OS.

description: Whether to remove `scripts` field from `package.json` files.

description: Snap options.

description: Options related to how build Windows targets.


grunt-cssmin-task.json

$ref: #/definitions/options

description: Set the options for cssmin

description: Prefix the compressed source with the given banner, with a linebreak in between.

description: To keep or remove special comments, exposing the underlying option from 'clean-css'.

type: number string

description: Either report only minification result or report minification and gzip results. This is useful to see exactly how well clean-css is performing but using  'gzip'  will make the task take 5-10x longer to complete.

enum: min gzip

default: min

title: JSON schema for the Grunt cssmin task


grunt-jshint-task.json

description: Set the options for JSHint

description: Either a boolean value or a string containing the file name of the jshintrc file.

type: boolean string

title: JSON schema for the Grunt JSHint task