Showing:

Annotations
Diagram
Properties
Constraints
Pattern Properties
Used By
Source
Schema sfdx-project.schema.json
Document version Draft 7
Annotations
Title  Salesforce DX Project File

Description  The properties and shape of the SFDX project
Diagram
sfdx-project.schema.json.html#/properties/packageDirectories sfdx-project.schema.json.html#/properties/namespace sfdx-project.schema.json.html#/properties/sourceApiVersion sfdx-project.schema.json.html#/properties/sfdcLoginUrl sfdx-project.schema.json.html#/properties/signupTargetLoginUrl sfdx-project.schema.json.html#/properties/oauthLocalPort sfdx-project.schema.json.html#/properties/plugins sfdx-project.schema.json.html#/properties/packageAliases #/definitions/packageDirectory.path #/definitions/packageDirectory.default #/definitions/packageDirectory.package #/definitions/packageDirectory.versionName #/definitions/packageDirectory.versionDescription #/definitions/packageDirectory.versionNumber #/definitions/packageDirectory.definitionFile #/definitions/packageDirectory.dependencies #/definitions/packageDirectory.ancestorId #/definitions/packageDirectory.ancestorVersion #/definitions/packageDirectory.releaseNotesUrl #/definitions/packageDirectory.postInstallUrl #/definitions/packageDirectory.postInstallScript #/definitions/packageDirectory.uninstallScript #/definitions/packageDirectory.includeProfileUserLicenses diagram
Type object
Properties
Name Occurrence
packageDirectories
namespace
sourceApiVersion
sfdcLoginUrl
signupTargetLoginUrl
oauthLocalPort
plugins
packageAliases
required
optional
optional
optional
optional
optional
optional
optional
Additional Properties false
Source

{
  "type": "object",
  "additionalProperties": false,
  "title": "Salesforce DX Project File",
  "description": "The properties and shape of the SFDX project",
  "$id": "http://schemas.salesforce.com/sfdx-project.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": ["packageDirectories"],
  "properties": {
    "packageDirectories": {
      "type": "array",
      "minItems": 1,
      "additionalItems": false,
      "title": "Package Directories",
      "description": "Package directories indicate which directories to target when syncing source to and from the scratch org. These directories can contain source from your managed package, unmanaged package, or unpackaged source, for example, ant tool or change set.",
      "$comment": "The properties ancestorId & ancestorVersion cannot be included together, but this schema optimizes for VS Code code completion rather than pure validation.",
      "items": {}
    },
    "namespace": {
      "type": "string",
      "title": "Namespace",
      "description": "The global namespace that is used with a package. The namespace must be registered with an org that is associated with your Dev Hub org. This namespace is assigned to scratch orgs created with the org:create command. If you’re creating an unlocked package, you have the option to create a package with no namespace."
    },
    "sourceApiVersion": {
      "type": "string",
      "title": "Source API Version",
      "description": "The API version that the source is compatible with. The default is the same version as the Salesforce CLI.",
      "default": "48.0"
    },
    "sfdcLoginUrl": {
      "type": "string",
      "title": "SFDC Login URL",
      "description": "The login URL that the force:auth commands use. If not specified, the default is login.salesforce.com. Override the default value if you want users to authorize to a specific Salesforce instance. For example, if you want to authorize into a sandbox org, set this parameter to test.salesforce.com.",
      "default": "https://login.salesforce.com"
    },
    "signupTargetLoginUrl": {
      "type": "string",
      "description": "The url that is used when creating new scratch orgs. This is typically only used for testing prerelease environments."
    },
    "oauthLocalPort": {
      "type": "number",
      "description": "By default, the OAuth port is 1717. However, change this port if this port is already in use, and you plan to create a connected app in your Dev Hub org to support JWT-based authorization."
    },
    "plugins": {
      "type": "object",
      "additionalProperties": true,
      "title": "CLI Plugins custom settings",
      "description": "Salesforce CLI plugin configurations used with this project."
    },
    "packageAliases": {
      "type": "object",
      "title": "Aliases for packaging ids",
      "description": "The Salesforce CLI updates this file with the aliases when you create a package or package version. You can also manually update this section for existing packages or package versions. You can use the alias instead of the cryptic package ID when running CLI force:package commands.",
      "patternProperties": {
        "^[ -~]+$": {
          "type": "string",
          "pattern": "^(0Ho|033|05i|04t)([a-zA-Z0-9]{15}|[a-zA-Z0-9]{12})$"
        }
      }
    }
  }
}


Property schema packageDirectories
Annotations
Title  Package Directories

Description  Package directories indicate which directories to target when syncing source to and from the scratch org. These directories can contain source from your managed package, unmanaged package, or unpackaged source, for example, ant tool or change set.
Diagram
sfdx-project.schema.json.html#/properties/packageDirectories/items diagram
Type array
Constraints
Unique Items : false

Array Items
Additional Items false
Used by
Schema
#/schema
Source

 "packageDirectories": {
  "type": "array",
  "minItems": 1,
  "additionalItems": false,
  "title": "Package Directories",
  "description": "Package directories indicate which directories to target when syncing source to and from the scratch org. These directories can contain source from your managed package, unmanaged package, or unpackaged source, for example, ant tool or change set.",
  "$comment": "The properties ancestorId & ancestorVersion cannot be included together, but this schema optimizes for VS Code code completion rather than pure validation.",
  "items": {
    "type": "object",
    "dependencies": {
      "ancestorId": [
        "versionNumber",
        "package"
      ],
      "ancestorVersion": [
        "versionNumber",
        "package"
      ],
      "definitionFile": [
        "versionNumber",
        "package"
      ],
      "dependencies": [
        "versionNumber",
        "package"
      ],
      "package": ["versionNumber"],
      "postInstallScript": [
        "versionNumber",
        "package"
      ],
      "postInstallUrl": [
        "versionNumber",
        "package"
      ],
      "releaseNotesUrl": [
        "versionNumber",
        "package"
      ],
      "uninstallScript": [
        "versionNumber",
        "package"
      ],
      "versionDescription": [
        "versionNumber",
        "package"
      ],
      "versionName": [
        "versionNumber",
        "package"
      ],
      "versionNumber": ["package"]
    },
    "additionalProperties": false,
    "required": ["path"],
    "properties": {
      "ancestorId": {"$ref": "#/definitions/packageDirectory.ancestorId"},
      "ancestorVersion": {"$ref": "#/definitions/packageDirectory.ancestorVersion"},
      "default": {"$ref": "#/definitions/packageDirectory.default"},
      "definitionFile": {"$ref": "#/definitions/packageDirectory.definitionFile"},
      "dependencies": {"$ref": "#/definitions/packageDirectory.dependencies"},
      "includeProfileUserLicenses": {"$ref": "#/definitions/packageDirectory.includeProfileUserLicenses"},
      "package": {"$ref": "#/definitions/packageDirectory.package"},
      "path": {"$ref": "#/definitions/packageDirectory.path"},
      "postInstallScript": {"$ref": "#/definitions/packageDirectory.postInstallScript"},
      "postInstallUrl": {"$ref": "#/definitions/packageDirectory.postInstallUrl"},
      "releaseNotesUrl": {"$ref": "#/definitions/packageDirectory.releaseNotesUrl"},
      "uninstallScript": {"$ref": "#/definitions/packageDirectory.uninstallScript"},
      "versionDescription": {"$ref": "#/definitions/packageDirectory.versionDescription"},
      "versionName": {"$ref": "#/definitions/packageDirectory.versionName"},
      "versionNumber": {"$ref": "#/definitions/packageDirectory.versionNumber"}
    }
  }
}


Property schema packageDirectories/items
Diagram
#/properties/packageDirectories/items/dependencies sfdx-project.schema.json.html#/properties/packageDirectories/items/properties/ancestorId sfdx-project.schema.json.html#/properties/packageDirectories/items/properties/ancestorVersion sfdx-project.schema.json.html#/properties/packageDirectories/items/properties/default sfdx-project.schema.json.html#/properties/packageDirectories/items/properties/definitionFile sfdx-project.schema.json.html#/properties/packageDirectories/items/properties/dependencies sfdx-project.schema.json.html#/properties/packageDirectories/items/properties/includeProfileUserLicenses sfdx-project.schema.json.html#/properties/packageDirectories/items/properties/package sfdx-project.schema.json.html#/properties/packageDirectories/items/properties/path sfdx-project.schema.json.html#/properties/packageDirectories/items/properties/postInstallScript sfdx-project.schema.json.html#/properties/packageDirectories/items/properties/postInstallUrl sfdx-project.schema.json.html#/properties/packageDirectories/items/properties/releaseNotesUrl sfdx-project.schema.json.html#/properties/packageDirectories/items/properties/uninstallScript sfdx-project.schema.json.html#/properties/packageDirectories/items/properties/versionDescription sfdx-project.schema.json.html#/properties/packageDirectories/items/properties/versionName sfdx-project.schema.json.html#/properties/packageDirectories/items/properties/versionNumber diagram
Type object
Properties
Name Occurrence
ancestorId
ancestorVersion
default
definitionFile
dependencies
includeProfileUserLicenses
package
path
postInstallScript
postInstallUrl
releaseNotesUrl
uninstallScript
versionDescription
versionName
versionNumber
optional
optional
optional
optional
optional
optional
optional
required
optional
optional
optional
optional
optional
optional
optional
Property Dependencies
Property Dependency
ancestorId
ancestorVersion
definitionFile
dependencies
package
postInstallScript
postInstallUrl
releaseNotesUrl
uninstallScript
versionDescription
versionName
versionNumber
versionNumber, package
versionNumber, package
versionNumber, package
versionNumber, package
versionNumber
versionNumber, package
versionNumber, package
versionNumber, package
versionNumber, package
versionNumber, package
versionNumber, package
package
Additional Properties false
Used by
Source

 "items": {
  "type": "object",
  "dependencies": {
    "ancestorId": [
      "versionNumber",
      "package"
    ],
    "ancestorVersion": [
      "versionNumber",
      "package"
    ],
    "definitionFile": [
      "versionNumber",
      "package"
    ],
    "dependencies": [
      "versionNumber",
      "package"
    ],
    "package": ["versionNumber"],
    "postInstallScript": [
      "versionNumber",
      "package"
    ],
    "postInstallUrl": [
      "versionNumber",
      "package"
    ],
    "releaseNotesUrl": [
      "versionNumber",
      "package"
    ],
    "uninstallScript": [
      "versionNumber",
      "package"
    ],
    "versionDescription": [
      "versionNumber",
      "package"
    ],
    "versionName": [
      "versionNumber",
      "package"
    ],
    "versionNumber": ["package"]
  },
  "additionalProperties": false,
  "required": ["path"],
  "properties": {
    "ancestorId": {"$ref": "#/definitions/packageDirectory.ancestorId"},
    "ancestorVersion": {"$ref": "#/definitions/packageDirectory.ancestorVersion"},
    "default": {"$ref": "#/definitions/packageDirectory.default"},
    "definitionFile": {"$ref": "#/definitions/packageDirectory.definitionFile"},
    "dependencies": {"$ref": "#/definitions/packageDirectory.dependencies"},
    "includeProfileUserLicenses": {"$ref": "#/definitions/packageDirectory.includeProfileUserLicenses"},
    "package": {"$ref": "#/definitions/packageDirectory.package"},
    "path": {"$ref": "#/definitions/packageDirectory.path"},
    "postInstallScript": {"$ref": "#/definitions/packageDirectory.postInstallScript"},
    "postInstallUrl": {"$ref": "#/definitions/packageDirectory.postInstallUrl"},
    "releaseNotesUrl": {"$ref": "#/definitions/packageDirectory.releaseNotesUrl"},
    "uninstallScript": {"$ref": "#/definitions/packageDirectory.uninstallScript"},
    "versionDescription": {"$ref": "#/definitions/packageDirectory.versionDescription"},
    "versionName": {"$ref": "#/definitions/packageDirectory.versionName"},
    "versionNumber": {"$ref": "#/definitions/packageDirectory.versionNumber"}
  }
}


Schema packageDirectory.ancestorId
Annotations
Title  Ancestor ID

Description  The ancestor that’s the immediate parent of the version that you’re creating. The package version ID to supply starts with '05i'.
Diagram
diagram
Type string
Used by
Source

 "packageDirectory.ancestorId": {
  "type": "string",
  "title": "Ancestor ID",
  "description": "The ancestor that’s the immediate parent of the version that you’re creating. The package version ID to supply starts with '05i'."
}


Definition schema ancestorId
Diagram
sfdx-project.schema.json.html#/definitions/packageDirectory.ancestorId diagram
Type reference
Refers packageDirectory.ancestorId
Used by
Source

 "ancestorId": {"$ref": "#/definitions/packageDirectory.ancestorId"}


Schema packageDirectory.ancestorVersion
Annotations
Title  Ancestor Version

Description  The ancestor that’s the immediate parent of the version that you’re creating. The ancestor version uses the format major.minor.patch.build.
Diagram
diagram
Type string
Used by
Source

 "packageDirectory.ancestorVersion": {
  "type": "string",
  "title": "Ancestor Version",
  "description": "The ancestor that’s the immediate parent of the version that you’re creating. The ancestor version uses the format major.minor.patch.build."
}


Definition schema ancestorVersion
Diagram
sfdx-project.schema.json.html#/definitions/packageDirectory.ancestorVersion diagram
Type reference
Refers packageDirectory.ancestorVersion
Used by
Source

 "ancestorVersion": {"$ref": "#/definitions/packageDirectory.ancestorVersion"}


Schema packageDirectory.default
Annotations
Title  Default

Description  If you have specified more than one path, include this parameter for the default path to indicate which is the default package directory.
Diagram
diagram
Type boolean
Default value : true
Used by
Source

 "packageDirectory.default": {
  "title": "Default",
  "description": "If you have specified more than one path, include this parameter for the default path to indicate which is the default package directory.",
  "default": true,
  "type": "boolean"
}


Definition schema default
Diagram
sfdx-project.schema.json.html#/definitions/packageDirectory.default diagram
Type reference
Refers packageDirectory.default
Used by
Source

 "default": {"$ref": "#/definitions/packageDirectory.default"}


Schema packageDirectory.definitionFile
Annotations
Title  Definition File

Description  Reference an external .json file to specify the features and org preferences required for the metadata of your package, such as the scratch org definition.
Diagram
diagram
Type string
Used by
Source

 "packageDirectory.definitionFile": {
  "type": "string",
  "title": "Definition File",
  "description": "Reference an external .json file to specify the features and org preferences required for the metadata of your package, such as the scratch org definition."
}


Definition schema definitionFile
Diagram
sfdx-project.schema.json.html#/definitions/packageDirectory.definitionFile diagram
Type reference
Refers packageDirectory.definitionFile
Used by
Source

 "definitionFile": {"$ref": "#/definitions/packageDirectory.definitionFile"}


Schema packageDirectory.dependencies
Annotations
Description  To specify dependencies for 2GP within the same Dev Hub, use either the package version alias or a combination of the package name and the version number.
Diagram
sfdx-project.schema.json.html#/definitions/packageDirectory.dependencies/items diagram
Type array
Constraints
Unique Items : false

Array Items
Used by
Source

 "packageDirectory.dependencies": {
  "type": "array",
  "description": "To specify dependencies for 2GP within the same Dev Hub, use either the package version alias or a combination of the package name and the version number.",
  "items": {
    "type": "object",
    "required": ["package"],
    "properties": {
      "package": {"type": "string"},
      "versionNumber": {"type": "string"}
    }
  }
}


Schema packageDirectory.dependencies/items
Diagram
sfdx-project.schema.json.html#/definitions/packageDirectory.dependencies/items/properties/package sfdx-project.schema.json.html#/definitions/packageDirectory.dependencies/items/properties/versionNumber diagram
Type object
Properties
Name Occurrence
package
versionNumber
required
optional
Used by
Source

 "items": {
  "type": "object",
  "required": ["package"],
  "properties": {
    "package": {"type": "string"},
    "versionNumber": {"type": "string"}
  }
}


Schema package
Diagram
diagram
Type string
Used by
Source

 "package": {"type": "string"}


Schema versionNumber
Diagram
diagram
Type string
Used by
Source

 "versionNumber": {"type": "string"}


Definition schema dependencies
Diagram
sfdx-project.schema.json.html#/definitions/packageDirectory.dependencies diagram
Type reference
Refers packageDirectory.dependencies
Used by
Source

 "dependencies": {"$ref": "#/definitions/packageDirectory.dependencies"}


Schema packageDirectory.includeProfileUserLicenses
Annotations
Title  Include Profile User Licenses

Description  Whether to include <userLicense> elements in profile metadata 
Diagram
diagram
Type boolean
Used by
Source

 "packageDirectory.includeProfileUserLicenses": {
  "title": "Include Profile User Licenses",
  "description": "Whether to include <userLicense> elements in profile metadata ",
  "type": "boolean"
}


Definition schema includeProfileUserLicenses
Diagram
sfdx-project.schema.json.html#/definitions/packageDirectory.includeProfileUserLicenses diagram
Type reference
Refers packageDirectory.includeProfileUserLicenses
Used by
Source

 "includeProfileUserLicenses": {"$ref": "#/definitions/packageDirectory.includeProfileUserLicenses"}


Schema packageDirectory.package
Annotations
Title  Package Identifier

Description  The package name you specified when creating the package.
Diagram
diagram
Type string
Used by
Source

 "packageDirectory.package": {
  "type": "string",
  "title": "Package Identifier",
  "description": "The package name you specified when creating the package."
}


Definition schema package
Diagram
sfdx-project.schema.json.html#/definitions/packageDirectory.package diagram
Type reference
Refers packageDirectory.package
Used by
Source

 "package": {"$ref": "#/definitions/packageDirectory.package"}


Schema packageDirectory.path
Annotations
Title  Path

Description  If you don’t specify a path, the Salesforce CLI uses a placeholder when you create a package.
Diagram
diagram
Type string
Used by
Source

 "packageDirectory.path": {
  "type": "string",
  "title": "Path",
  "description": "If you don’t specify a path, the Salesforce CLI uses a placeholder when you create a package."
}


Definition schema path
Diagram
sfdx-project.schema.json.html#/definitions/packageDirectory.path diagram
Type reference
Refers packageDirectory.path
Used by
Source

 "path": {"$ref": "#/definitions/packageDirectory.path"}


Schema packageDirectory.postInstallScript
Annotations
Title  Post Install Script

Description  The post install script.
Diagram
diagram
Type string
Used by
Source

 "packageDirectory.postInstallScript": {
  "type": "string",
  "title": "Post Install Script",
  "description": "The post install script."
}


Definition schema postInstallScript
Diagram
sfdx-project.schema.json.html#/definitions/packageDirectory.postInstallScript diagram
Type reference
Refers packageDirectory.postInstallScript
Used by
Source

 "postInstallScript": {"$ref": "#/definitions/packageDirectory.postInstallScript"}


Schema packageDirectory.postInstallUrl
Annotations
Title  Post Install Url

Description  The post install url.
Diagram
diagram
Type string
Used by
Source

 "packageDirectory.postInstallUrl": {
  "type": "string",
  "title": "Post Install Url",
  "description": "The post install url."
}


Definition schema postInstallUrl
Diagram
sfdx-project.schema.json.html#/definitions/packageDirectory.postInstallUrl diagram
Type reference
Refers packageDirectory.postInstallUrl
Used by
Source

 "postInstallUrl": {"$ref": "#/definitions/packageDirectory.postInstallUrl"}


Schema packageDirectory.releaseNotesUrl
Annotations
Title  Release Notes Url

Description  The release notes url.
Diagram
diagram
Type string
Used by
Source

 "packageDirectory.releaseNotesUrl": {
  "type": "string",
  "title": "Release Notes Url",
  "description": "The release notes url."
}


Definition schema releaseNotesUrl
Diagram
sfdx-project.schema.json.html#/definitions/packageDirectory.releaseNotesUrl diagram
Type reference
Refers packageDirectory.releaseNotesUrl
Used by
Source

 "releaseNotesUrl": {"$ref": "#/definitions/packageDirectory.releaseNotesUrl"}


Schema packageDirectory.uninstallScript
Annotations
Title  Uninstall Script

Description  The uninstall script.
Diagram
diagram
Type string
Used by
Source

 "packageDirectory.uninstallScript": {
  "type": "string",
  "title": "Uninstall Script",
  "description": "The uninstall script."
}


Definition schema uninstallScript
Diagram
sfdx-project.schema.json.html#/definitions/packageDirectory.uninstallScript diagram
Type reference
Refers packageDirectory.uninstallScript
Used by
Source

 "uninstallScript": {"$ref": "#/definitions/packageDirectory.uninstallScript"}


Schema packageDirectory.versionDescription
Annotations
Title  Version Description

Description  Human readable version information, format not specified.
Diagram
diagram
Type string
Used by
Source

 "packageDirectory.versionDescription": {
  "type": "string",
  "title": "Version Description",
  "description": "Human readable version information, format not specified."
}


Definition schema versionDescription
Diagram
sfdx-project.schema.json.html#/definitions/packageDirectory.versionDescription diagram
Type reference
Refers packageDirectory.versionDescription
Used by
Source

 "versionDescription": {"$ref": "#/definitions/packageDirectory.versionDescription"}


Schema packageDirectory.versionName
Annotations
Title  Version Name

Description  If not specified, the CLI uses versionNumber as the version name.
Diagram
diagram
Type string
Used by
Source

 "packageDirectory.versionName": {
  "type": "string",
  "title": "Version Name",
  "description": "If not specified, the CLI uses versionNumber as the version name."
}


Definition schema versionName
Diagram
sfdx-project.schema.json.html#/definitions/packageDirectory.versionName diagram
Type reference
Refers packageDirectory.versionName
Used by
Source

 "versionName": {"$ref": "#/definitions/packageDirectory.versionName"}


Schema packageDirectory.versionNumber
Annotations
Title  Version Number

Description  Version numbers are formatted as major.minor.patch.build. For example, 1.2.1.8.
Diagram
diagram
Type string
Used by
Source

 "packageDirectory.versionNumber": {
  "type": "string",
  "title": "Version Number",
  "description": "Version numbers are formatted as major.minor.patch.build. For example, 1.2.1.8."
}


Definition schema versionNumber
Diagram
sfdx-project.schema.json.html#/definitions/packageDirectory.versionNumber diagram
Type reference
Refers packageDirectory.versionNumber
Used by
Source

 "versionNumber": {"$ref": "#/definitions/packageDirectory.versionNumber"}


Property schema namespace
Annotations
Title  Namespace

Description  The global namespace that is used with a package. The namespace must be registered with an org that is associated with your Dev Hub org. This namespace is assigned to scratch orgs created with the org:create command. If you’re creating an unlocked package, you have the option to create a package with no namespace.
Diagram
diagram
Type string
Used by
Schema
#/schema
Source

 "namespace": {
  "type": "string",
  "title": "Namespace",
  "description": "The global namespace that is used with a package. The namespace must be registered with an org that is associated with your Dev Hub org. This namespace is assigned to scratch orgs created with the org:create command. If you’re creating an unlocked package, you have the option to create a package with no namespace."
}


Property schema sourceApiVersion
Annotations
Title  Source API Version

Description  The API version that the source is compatible with. The default is the same version as the Salesforce CLI.
Diagram
diagram
Type string
Constraints
Default : 48.0

Used by
Schema
#/schema
Source

 "sourceApiVersion": {
  "type": "string",
  "title": "Source API Version",
  "description": "The API version that the source is compatible with. The default is the same version as the Salesforce CLI.",
  "default": "48.0"
}


Property schema sfdcLoginUrl
Annotations
Title  SFDC Login URL

Description  The login URL that the force:auth commands use. If not specified, the default is login.salesforce.com. Override the default value if you want users to authorize to a specific Salesforce instance. For example, if you want to authorize into a sandbox org, set this parameter to test.salesforce.com.
Diagram
diagram
Type string
Constraints
Default : https://login.salesforce.com

Used by
Schema
#/schema
Source

 "sfdcLoginUrl": {
  "type": "string",
  "title": "SFDC Login URL",
  "description": "The login URL that the force:auth commands use. If not specified, the default is login.salesforce.com. Override the default value if you want users to authorize to a specific Salesforce instance. For example, if you want to authorize into a sandbox org, set this parameter to test.salesforce.com.",
  "default": "https://login.salesforce.com"
}


Property schema signupTargetLoginUrl
Annotations
Description  The url that is used when creating new scratch orgs. This is typically only used for testing prerelease environments.
Diagram
diagram
Type string
Used by
Schema
#/schema
Source

 "signupTargetLoginUrl": {
  "type": "string",
  "description": "The url that is used when creating new scratch orgs. This is typically only used for testing prerelease environments."
}


Property schema oauthLocalPort
Annotations
Description  By default, the OAuth port is 1717. However, change this port if this port is already in use, and you plan to create a connected app in your Dev Hub org to support JWT-based authorization.
Diagram
diagram
Type number
Used by
Schema
#/schema
Source

 "oauthLocalPort": {
  "type": "number",
  "description": "By default, the OAuth port is 1717. However, change this port if this port is already in use, and you plan to create a connected app in your Dev Hub org to support JWT-based authorization."
}


Property schema plugins
Annotations
Title  CLI Plugins custom settings

Description  Salesforce CLI plugin configurations used with this project.
Diagram
diagram
Type object
Additional Properties true
Used by
Schema
#/schema
Source

 "plugins": {
  "type": "object",
  "additionalProperties": true,
  "title": "CLI Plugins custom settings",
  "description": "Salesforce CLI plugin configurations used with this project."
}


Property schema packageAliases
Annotations
Title  Aliases for packaging ids

Description  The Salesforce CLI updates this file with the aliases when you create a package or package version. You can also manually update this section for existing packages or package versions. You can use the alias instead of the cryptic package ID when running CLI force:package commands.
Diagram
#/properties/packageAliases/patternProperties/%5E%5B%20-~%5D+$ diagram
Type object
Pattern Properties
Name
^[ -~]+$
Used by
Schema
#/schema
Source

 "packageAliases": {
  "type": "object",
  "title": "Aliases for packaging ids",
  "description": "The Salesforce CLI updates this file with the aliases when you create a package or package version. You can also manually update this section for existing packages or package versions. You can use the alias instead of the cryptic package ID when running CLI force:package commands.",
  "patternProperties": {
    "^[ -~]+$": {
      "type": "string",
      "pattern": "^(0Ho|033|05i|04t)([a-zA-Z0-9]{15}|[a-zA-Z0-9]{12})$"
    }
  }
}


Property schema ^[ -~0]+$
Diagram
diagram
Type string
Constraints
Pattern : ^(0Ho|033|05i|04t)([a-zA-Z0-9]{15}|[a-zA-Z0-9]{12})$

Used by
Source

 "^[ -~0]+$": {
  "type": "string",
  "pattern": "^(0Ho|033|05i|04t)([a-zA-Z0-9]{15}|[a-zA-Z0-9]{12})$"
}