@salesforce/plugin-org

{ "commands": { "org:display": { "aliases": [ "force:org:display" ], "args": {}, "deprecateAliases": true, "description": "Output includes your access token, client Id, connected status, org ID, instance URL, username, and alias, if applicable.\n\nUse --verbose to include the SFDX auth URL. WARNING: The SFDX auth URL contains sensitive information, such as a refresh token that can be used to access an org. Don't share or distribute this URL or token.\n\nIncluding --verbose displays the sfdxAuthUrl property only if you authenticated to the org using \"org login web\" (not \"org login jwt\").", "examples": [ "Display information about your default org:\n$ <%= config.bin %> <%= command.id %>", "Display information, including the sfdxAuthUrl property, about the org with alias TestOrg1:\n$ <%= config.bin %> <%= command.id %> --target-org TestOrg1 --verbose" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "name": "verbose", "summary": "Display the sfdxAuthUrl property.", "allowNo": false, "type": "boolean" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "org:display", "pluginAlias": "@salesforce/plugin-org", "pluginName": "@salesforce/plugin-org", "pluginType": "core", "strict": true, "summary": "Display information about an org.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "org", "display.js" ], "aliasPermutations": [ "force:org:display", "org:force:display", "org:display:force", "force:display:org", "display:force:org", "display:org:force" ], "permutations": [ "org:display", "display:org" ] }, "org:list": { "aliases": [ "force:org:list" ], "args": {}, "deprecateAliases": true, "examples": [ "List all orgs you've created or authenticated to:\n$ <%= config.bin %> <%= command.id %>", "List all orgs, including expired, deleted, and unknown-status orgs; don't include the connection status:\n$ <%= config.bin %> <%= command.id %> --skip-connection-status --all", "List orgs and remove local org authorization info about non-active scratch orgs:\n$ <%= config.bin %> <%= command.id %> --clean" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "name": "verbose", "summary": "List more information about each org.", "allowNo": false, "type": "boolean" }, "all": { "name": "all", "summary": "Include expired, deleted, and unknown-status scratch orgs.", "allowNo": false, "type": "boolean" }, "clean": { "name": "clean", "summary": "Remove all local org authorizations for non-active scratch orgs. Use \"org logout\" to remove non-scratch orgs.", "allowNo": false, "type": "boolean" }, "no-prompt": { "aliases": [ "noprompt" ], "char": "p", "deprecateAliases": true, "name": "no-prompt", "relationships": [ { "type": "some", "flags": [ { "name": "clean" } ] } ], "summary": "Don't prompt for confirmation.", "allowNo": false, "type": "boolean" }, "skip-connection-status": { "aliases": [ "skipconnectionstatus" ], "deprecateAliases": true, "name": "skip-connection-status", "summary": "Skip retrieving the connection status of non-scratch orgs.", "allowNo": false, "type": "boolean" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "org:list", "pluginAlias": "@salesforce/plugin-org", "pluginName": "@salesforce/plugin-org", "pluginType": "core", "strict": true, "summary": "List all orgs you’ve created or authenticated to.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "org", "list.js" ], "aliasPermutations": [ "force:org:list", "org:force:list", "org:list:force", "force:list:org", "list:force:org", "list:org:force" ], "permutations": [ "org:list", "list:org" ] }, "org:open": { "aliases": [ "force:org:open", "force:source:open" ], "args": {}, "deprecateAliases": true, "description": "To open a specific page, specify the portion of the URL after \"https://mydomain.my.salesforce.com\" as the value for the --path flag. For example, specify \"--path lightning\" to open Lightning Experience, or specify \"--path /apex/YourPage\" to open a Visualforce page.\n\nUse the --source-file flag to open ApexPage, FlexiPage, Flow, or Agent metadata from your local project in the associated Builder within the Org.\n\nTo generate a URL but not launch it in your browser, specify --url-only.\n\nTo open in a specific browser, use the --browser flag. Supported browsers are \"chrome\", \"edge\", and \"firefox\". If you don't specify --browser, the org opens in your default browser.", "examples": [ "Open your default org in your default browser:\n$ <%= config.bin %> <%= command.id %>", "Open your default org in an incognito window of your default browser:\n$ <%= config.bin %> <%= command.id %> --private", "Open the org with alias MyTestOrg1 in the Firefox browser:\n$ <%= config.bin %> <%= command.id %> --target-org MyTestOrg1 --browser firefox", "Display the navigation URL for the Lightning Experience page for your default org, but don't open the page in a browser:\n$ <%= config.bin %> <%= command.id %> --url-only --path lightning", "Open a local Lightning page in your default org's Lightning App Builder:\n$ <%= config.bin %> <%= command.id %> --source-file force-app/main/default/flexipages/Hello.flexipage-meta.xml", "Open a local Flow in Flow Builder:\n$ <%= config.bin %> <%= command.id %> --source-file force-app/main/default/flows/Hello.flow-meta.xml", "Open local Agent metadata (Bot) in Agent Builder:\n$ <%= config.bin %> <%= command.id %> --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "aliases": [ "apiversion" ], "deprecateAliases": true, "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "private": { "exclusive": [ "url-only", "browser" ], "name": "private", "summary": "Open the org in the default browser using private (incognito) mode.", "allowNo": false, "type": "boolean" }, "browser": { "char": "b", "exclusive": [ "url-only", "private" ], "name": "browser", "summary": "Browser where the org opens.", "hasDynamicHelp": false, "multiple": false, "options": [ "chrome", "edge", "firefox" ], "type": "option" }, "path": { "char": "p", "env": "FORCE_OPEN_URL", "exclusive": [ "source-file" ], "name": "path", "summary": "Navigation URL path to open a specific page.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "url-only": { "aliases": [ "urlonly" ], "char": "r", "deprecateAliases": true, "name": "url-only", "summary": "Display navigation URL, but don’t launch browser.", "allowNo": false, "type": "boolean" }, "loglevel": { "deprecated": { "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable." }, "hidden": true, "name": "loglevel", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-file": { "aliases": [ "sourcefile" ], "char": "f", "deprecateAliases": true, "exclusive": [ "path" ], "name": "source-file", "summary": "Path to ApexPage, FlexiPage, Flow, or Agent metadata to open in the associated Builder.", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "org:open", "pluginAlias": "@salesforce/plugin-org", "pluginName": "@salesforce/plugin-org", "pluginType": "core", "strict": true, "summary": "Open your default scratch org, or another specified org, in a browser.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "org", "open.js" ], "aliasPermutations": [ "force:org:open", "org:force:open", "org:open:force", "force:open:org", "open:force:org", "open:org:force", "force:source:open", "source:force:open", "source:open:force", "force:open:source", "open:force:source", "open:source:force" ], "permutations": [ "org:open", "open:org" ] }, "org:auth:show-access-token": { "aliases": [], "args": {}, "description": "Because access tokens are sensitive credentials that grant full access to an org, this command prompts for confirmation before revealing the token. Skip confirmation by specifying either the --no-prompt or --json flag.", "examples": [ "Show the access token for the default org:\n<%= config.bin %> <%= command.id %>", "Show the access token for an org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --target-org my-org", "Show the access token without the confirmation prompt:\n<%= config.bin %> <%= command.id %> --target-org my-org --no-prompt", "Get the access token as JSON for use in scripts:\n<%= config.bin %> <%= command.id %> --target-org my-org --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "char": "o", "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "no-prompt": { "char": "p", "name": "no-prompt", "summary": "Skip the security warning and reveal the access token without confirmation.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "org:auth:show-access-token", "pluginAlias": "@salesforce/plugin-org", "pluginName": "@salesforce/plugin-org", "pluginType": "core", "strict": true, "summary": "Show the current access token for an org.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "org", "auth", "show-access-token.js" ], "aliasPermutations": [], "permutations": [ "org:auth:show-access-token", "auth:org:show-access-token", "auth:show-access-token:org", "org:show-access-token:auth", "show-access-token:org:auth", "show-access-token:auth:org" ] }, "org:auth:show-sfdx-auth-url": { "aliases": [], "args": {}, "description": "Shows the SFDX Auth URL for an org. This URL is only available for orgs authenticated via a web-based OAuth flow. This command prompts for confirmation before revealing it. Skip confirmation by specifying either the --no-prompt or --json flag.", "examples": [ "Show the SFDX Auth URL for the default org:\n<%= config.bin %> <%= command.id %>", "Show the SFDX Auth URL for an org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --target-org my-org", "Show the SFDX Auth URL without the confirmation prompt:\n<%= config.bin %> <%= command.id %> --target-org my-org --no-prompt", "Get the SFDX Auth URL as JSON for use in scripts:\n<%= config.bin %> <%= command.id %> --target-org my-org --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "char": "o", "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "no-prompt": { "char": "p", "name": "no-prompt", "summary": "Skip the security warning and reveal the SFDX Auth URL without confirmation.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "org:auth:show-sfdx-auth-url", "pluginAlias": "@salesforce/plugin-org", "pluginName": "@salesforce/plugin-org", "pluginType": "core", "strict": true, "summary": "Show the SFDX Auth URL for an org.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "org", "auth", "show-sfdx-auth-url.js" ], "aliasPermutations": [], "permutations": [ "org:auth:show-sfdx-auth-url", "auth:org:show-sfdx-auth-url", "auth:show-sfdx-auth-url:org", "org:show-sfdx-auth-url:auth", "show-sfdx-auth-url:org:auth", "show-sfdx-auth-url:auth:org" ] }, "org:auth:show-user-password": { "aliases": [], "args": {}, "description": "This command shows only passwords that were generated locally in your DX project with either the \"org generate password\" or \"org create user\" CLI command. If you generated a password for a user in Setup in your org, you can't show it with this command.\n\nBecause passwords are sensitive credentials, this command prompts for confirmation before revealing it. Skip confirmation by specifying either the --no-prompt or --json flag.", "examples": [ "Show the password for the default org's user:\n<%= config.bin %> <%= command.id %>", "Show the password for an org with alias \"my-org\":\n<%= config.bin %> <%= command.id %> --target-org my-org", "Show the password without the confirmation prompt:\n<%= config.bin %> <%= command.id %> --target-org my-org --no-prompt", "Get the password as JSON for use in scripts:\n<%= config.bin %> <%= command.id %> --target-org my-org --json" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "char": "o", "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "no-prompt": { "char": "p", "name": "no-prompt", "summary": "Skip the security warning and reveal the password without confirmation.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "org:auth:show-user-password", "pluginAlias": "@salesforce/plugin-org", "pluginName": "@salesforce/plugin-org", "pluginType": "core", "strict": true, "summary": "Show the stored password for an org's user.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "org", "auth", "show-user-password.js" ], "aliasPermutations": [], "permutations": [ "org:auth:show-user-password", "auth:org:show-user-password", "auth:show-user-password:org", "org:show-user-password:auth", "show-user-password:org:auth", "show-user-password:auth:org" ] }, "org:delete:sandbox": { "aliases": [ "env:delete:sandbox" ], "args": {}, "deprecateAliases": true, "description": "Salesforce CLI marks the org for deletion in the production org that contains the sandbox licenses and then deletes all local references to the org from your computer.\nSpecify a sandbox with either the username you used when you logged into it, or the alias you gave the sandbox when you created it. Run \"<%= config.bin %> org list\" to view all your orgs, including sandboxes, and their aliases.\nBoth the sandbox and the associated production org must already be authenticated with the CLI to successfully delete the sandbox.", "examples": [ "Delete a sandbox with alias my-sandbox:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox", "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org myusername@example.com.qa", "Delete the sandbox without prompting to confirm:\n<%= config.bin %> <%= command.id %> --target-org my-sandbox --no-prompt" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "name": "target-org", "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "no-prompt": { "char": "p", "name": "no-prompt", "summary": "Don't prompt the user to confirm the deletion.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "org:delete:sandbox", "pluginAlias": "@salesforce/plugin-org", "pluginName": "@salesforce/plugin-org", "pluginType": "core", "strict": true, "summary": "Delete a sandbox.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "org", "delete", "sandbox.js" ], "aliasPermutations": [ "env:delete:sandbox", "delete:env:sandbox", "delete:sandbox:env", "env:sandbox:delete", "sandbox:env:delete", "sandbox:delete:env" ], "permutations": [ "org:delete:sandbox", "delete:org:sandbox", "delete:sandbox:org", "org:sandbox:delete", "sandbox:org:delete", "sandbox:delete:org" ] }, "org:delete:scratch": { "aliases": [ "env:delete:scratch" ], "args": {}, "deprecateAliases": true, "description": "Salesforce CLI marks the org for deletion in the Dev Hub org and then deletes all local references to the org from your computer.\nSpecify a scratch org with either the username or the alias you gave the scratch org when you created it. Run \"<%= config.bin %> org list\" to view all your orgs, including scratch orgs, and their aliases.", "examples": [ "Delete a scratch org with alias my-scratch-org:\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org", "Specify a username instead of an alias:\n<%= config.bin %> <%= command.id %> --target-org test-123456-abcdefg@example.com", "Delete the scratch org without prompting to confirm :\n<%= config.bin %> <%= command.id %> --target-org my-scratch-org --no-prompt" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "aliases": [ "targetusername", "u" ], "char": "o", "deprecateAliases": true, "name": "target-org", "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "no-prompt": { "char": "p", "name": "no-prompt", "summary": "Don't prompt the user to confirm the deletion.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "org:delete:scratch", "pluginAlias": "@salesforce/plugin-org", "pluginName": "@salesforce/plugin-org", "pluginType": "core", "strict": true, "summary": "Delete a scratch org.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "org", "delete", "scratch.js" ], "aliasPermutations": [ "env:delete:scratch", "delete:env:scratch", "delete:scratch:env", "env:scratch:delete", "scratch:env:delete", "scratch:delete:env" ], "permutations": [ "org:delete:scratch", "delete:org:scratch", "delete:scratch:org", "org:scratch:delete", "scratch:org:delete", "scratch:delete:org" ] }, "org:create:agent-user": { "aliases": [], "args": {}, "description": "You specify this user in the agent's Agent Script file using the \"default_agent_user\" parameter in the \"config\" block.\n\nBy default, this command:\n\n- Generates a user called \"Agent User\" with a globally unique username. Use flags to change these default names.\n- Sets the user's email to the new username.\n- Assigns the user the \"Einstein Agent User\" profile.\n- Assigns the user these required permission sets: AgentforceServiceAgentBase, AgentforceServiceAgentUser,\n EinsteinGPTPromptTemplateUser\n- Checks that the user licenses required by the profile and permission sets are available in your org.\n\nThe generated user doesn't have a password. You can’t log into Salesforce using the agent user's username. Only\nSalesforce users with admin permissions can view or edit an agent user in Setup.\n\nTo assign additional permission sets or licenses after the user was created, use the \"org assign permset\" or \"org assign\npermsetlicense\" commands.\n\nWhen the command completes, it displays a summary of what it did, including the new agent user's username and ID, the\navailable licenses associated with the Einstein Agent User profile, and the profile and permission sets assigned to the\nagent user.", "examples": [ "Create an agent user with an auto-generated username; create the user in the org with alias \"myorg\":\n<%= config.bin %> <%= command.id %> --target-org myorg", "Create an agent user by specifying a base username pattern; to make the username unique, the command appends a unique\nidentifier:\n<%= config.bin %> <%= command.id %> --base-username service-agent@corp.com --target-org myorg", "Create an agent user with an auto-generated username but the custom name \"Service Agent\"; create the user in your\ndefault org:\n<%= config.bin %> <%= command.id %> --first-name Service --last-name Agent" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-org": { "char": "o", "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "api-version": { "description": "Override the api version used for api requests made by this command", "name": "api-version", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "base-username": { "description": "Specify a base username in email format, such as \"service-agent@corp.com\". The command then appends a 12-character\nglobally unique ID (GUID) to the name before the \"@\" sign, which ensures that the username is globally unique across all\nSalesforce orgs and sandboxes.\n\nFor example, if you specify \"service-agent@corp.com\", then the username might be \"service-agent.a1b2c3d4e5f6@corp.com\".\n\nIf not specified, the command auto-generates the username using this pattern: \"agent.user.<GUID>@your-org-domain.com\".", "name": "base-username", "summary": "Base username pattern. A unique ID is appended to ensure global uniqueness of the usename.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "first-name": { "name": "first-name", "summary": "First name for the agent user.", "default": "Agent", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "last-name": { "name": "last-name", "summary": "Last name for the agent user.", "default": "User", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "org:create:agent-user", "pluginAlias": "@salesforce/plugin-org", "pluginName": "@salesforce/plugin-org", "pluginType": "core", "strict": true, "summary": "Create the default Salesforce user that is used to run an agent.", "enableJsonFlag": true, "isESM": true, "relativePath": [ "lib", "commands", "org", "create", "agent-user.js" ], "aliasPermutations": [], "permutations": [ "org:create:agent-user", "create:org:agent-user", "create:agent-user:org", "org:agent-user:create", "agent-user:org:create", "agent-user:create:org" ] }, "org:create:sandbox": { "aliases": [ "env:create:sandbox" ], "args": {}, "deprecateAliases": true, "description": "There are two ways to create a sandbox org: specify a definition file that contains the sandbox options or use the --name and --license-type flags to specify the two required options. If you want to set an option other than name or license type, such as apexClassId, you must use a definition file.\n\nYou can also use this command to clone an existing sandbox. Use the --source-sandbox-name flag to specify the existing sandbox name and the --name flag to the name of the new sandbox.", "examples": [ "Create a sandbox org using a definition file and give it the alias \"MyDevSandbox\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --definition-file config/dev-sandbox-def.json --alias MyDevSandbox --target-org prodOrg", "Create a sandbox org by directly specifying its name and type of license (Developer) instead of using a definition file. Set the sandbox org as your default.\n<%= config.bin %> <%= command.id %> --name mysandbox --license-type Developer --alias MyDevSandbox --target-org prodOrg --set-default", "Clone the existing sandbox with name \"ExistingSandbox\" and name the new sandbox \"NewClonedSandbox\". Set the new sandbox as your default org. Wait for 30 minutes for the sandbox creation to complete.\n<%= config.bin %> <%= command.id %> --source-sandbox-name ExistingSandbox --name NewClonedSandbox --target-org prodOrg --alias MyDevSandbox --set-default --wait 30", "Clone the existing sandbox with ID \"0GQB0000000TVobOAG\" and do not wait.\n<%= config.bin %> <%= command.id %> --source-id 0GQB0000000TVobOAG --name SbxClone --target-org prodOrg --async" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "definition-file": { "char": "f", "description": "The sandbox definition file is a blueprint for the sandbox. You can create different definition files for each sandbox type that you use in the development process. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.", "name": "definition-file", "summary": "Path to a sandbox definition file.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "set-default": { "char": "s", "name": "set-default", "summary": "Set the sandbox org as your default org.", "allowNo": false, "type": "boolean" }, "alias": { "char": "a", "description": "When you create a sandbox, the generated usernames are based on the usernames present in the production org. To ensure uniqueness, the new usernames are appended with the name of the sandbox. For example, the username \"user@example.com\" in the production org results in the username \"user@example.com.mysandbox\" in a sandbox named \"mysandbox\". When you set an alias for a sandbox org, it's assigned to the resulting username of the user running this command.", "name": "alias", "summary": "Alias for the sandbox org.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "wait": { "char": "w", "description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command you run to check the status of the create. The displayed command includes the job ID for the running sandbox creation.", "exclusive": [ "async" ], "name": "wait", "summary": "Number of minutes to wait for the sandbox org to be ready.", "hasDynamicHelp": true, "helpValue": "<minutes>", "multiple": false, "type": "option" }, "poll-interval": { "char": "i", "exclusive": [ "async" ], "name": "poll-interval", "summary": "Number of seconds to wait between retries.", "hasDynamicHelp": true, "helpValue": "<seconds>", "multiple": false, "type": "option" }, "async": { "description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox creation, run \"<%= config.bin %> org resume sandbox\".", "exclusive": [ "wait", "poll-interval" ], "name": "async", "summary": "Request the sandbox creation, but don't wait for it to complete.", "allowNo": false, "type": "boolean" }, "name": { "char": "n", "description": "The name must be a unique alphanumeric string (10 or fewer characters) to identify the sandbox. You can’t reuse a name while a sandbox is in the process of being deleted.", "name": "name", "summary": "Name of the sandbox org.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-sandbox-name": { "aliases": [ "clone", "c" ], "deprecateAliases": true, "description": "The value of --source-sandbox-name must be an existing sandbox. The existing sandbox, and the new sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.", "exclusive": [ "license-type", "source-id" ], "name": "source-sandbox-name", "summary": "Name of the sandbox org to clone.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "source-id": { "description": "The value of --source-id must be an existing sandbox (SandboxInfo.Id). The existing sandbox, and the new sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.\n\nYou can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.", "exclusive": [ "license-type", "source-sandbox-name" ], "name": "source-id", "summary": "ID of the sandbox org to clone.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "license-type": { "char": "l", "exclusive": [ "source-sandbox-name", "source-id" ], "name": "license-type", "summary": "Type of sandbox license.", "hasDynamicHelp": false, "multiple": false, "options": [ "Developer", "Developer_Pro", "Partial", "Full" ], "type": "option" }, "target-org": { "char": "o", "description": "When it creates the sandbox org, Salesforce copies the metadata, and optionally data, from your production org to the new sandbox org.", "name": "target-org", "noCacheDefault": true, "required": true, "summary": "Username or alias of the production org that contains the sandbox license.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "no-prompt": { "name": "no-prompt", "summary": "Don't prompt for confirmation about the sandbox configuration.", "allowNo": false, "type": "boolean" }, "no-track-source": { "description": "We recommend you enable source tracking in Developer and Developer Pro sandbox, which is why it's the default behavior. Source tracking allows you to track the changes you make to your metadata, both in your local project and in the sandbox, and to detect any conflicts between the two.\n\nTo disable source tracking in the new sandbox, specify the --no-track-source flag. The main reason to disable source tracking is for performance. For example, while you probably want to deploy metadata and run Apex tests in your CI/CD jobs, you probably don't want to incur the costs of source tracking (checking for conflicts, polling the SourceMember object, various file system operations.) This is a good use case for disabling source tracking in the sandbox.", "name": "no-track-source", "summary": "Do not use source tracking for this sandbox.", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": true, "hiddenAliases": [], "id": "org:create:sandbox", "pluginAlias": "@salesforce/plugin-org", "pluginName": "@salesforce/plugin-org", "pluginType": "core", "strict": true, "summary": "Create a sandbox org.", "isESM": true, "relativePath": [ "lib", "commands", "org", "create", "sandbox.js" ], "aliasPermutations": [ "env:create:sandbox", "create:env:sandbox", "create:sandbox:env", "env:sandbox:create", "sandbox:env:create", "sandbox:create:env" ], "permutations": [ "org:create:sandbox", "create:org:sandbox", "create:sandbox:org", "org:sandbox:create", "sandbox:org:create", "sandbox:create:org" ] }, "org:create:scratch": { "aliases": [ "env:create:scratch" ], "args": {}, "deprecateAliases": true, "description": "There are four ways to create a scratch org:\n\n * Specify a definition file that contains the scratch org options.\n * Use the --edition flag to specify the one required option; this method doesn't require a defintion file.\n * Use the --snapshot flag to create a scratch org from a snapshot. Snapshots are a point-in-time copy of a scratch org; you create a snapshot with the \"sf org create snapshot\" command.\n * Use the --source-org flag to create a scratch org from an org shape. Org shapes mimic the baseline setup of a source org without the extraneous data and metadata; you create an org shape with the \"sf org create shape\" command.\n\nThe --edition, --snapshot, and --source-org flags are mutually exclusive, which means if you specify one, you can't also specify the others.\n\nFor any of the methods, you can also use these flags; if you use them with --definition-file, they override their equivalent option in the scratch org definition file:\n\n * --description\n * --name (equivalent to the \"orgName\" option)\n * --username\n * --release\n * --admin-email (equivalent to the \"adminEmail\" option)\n\nIf you want to set options such as org features or settings, you must use a definition file.\n\nYou must specify a Dev Hub to create a scratch org, either with the --target-dev-hub flag or by setting your default Dev Hub with the target-dev-hub configuration variable.", "examples": [ "Create a Developer edition scratch org using your default Dev Hub and give the scratch org an alias:\n<%= config.bin %> <%= command.id %> --edition developer --alias my-scratch-org", "Create a scratch org with a definition file. Specify the Dev Hub using its alias, set the scratch org as your default, and specify that it expires in 3 days:\n<%= config.bin %> <%= command.id %> --target-dev-hub MyHub --definition-file config/project-scratch-def.json --set-default --duration-days 3", "Create a preview Enterprise edition scratch org; for use only during Salesforce release transition periods:\n<%= config.bin %> <%= command.id %> --edition enterprise --alias my-scratch-org --target-dev-hub MyHub --release preview", "Create a scratch org from a snapshot called \"NightlyBranch\"; be sure you specify the same Dev Hub org associated with the snapshot. We recommend you increase the --wait time because creating a scratch org from a snapshot can take a while:\n<%= config.bin %> <%= command.id %> --alias my-scratch-org --target-dev-hub MyHub --snapshot NightlyBranch --wait 10" ], "flags": { "json": { "description": "Format output as json.", "helpGroup": "GLOBAL", "name": "json", "allowNo": false, "type": "boolean" }, "flags-dir": { "helpGroup": "GLOBAL", "name": "flags-dir", "summary": "Import flag values from a directory.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "alias": { "char": "a", "description": "New scratch orgs include one administrator by default. The admin user's username is auto-generated and looks something like test-wvkpnfm5z113@example.com. When you set an alias for a new scratch org, it's assigned this username.", "name": "alias", "summary": "Alias for the scratch org.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "async": { "description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To resume the scratch org creation, run \"<%= config.bin %> org resume scratch\".", "name": "async", "summary": "Request the org, but don't wait for it to complete.", "allowNo": false, "type": "boolean" }, "set-default": { "char": "d", "name": "set-default", "summary": "Set the scratch org as your default org", "allowNo": false, "type": "boolean" }, "definition-file": { "char": "f", "description": "The scratch org definition file is a blueprint for the scratch org. It mimics the shape of an org that you use in the development life cycle, such as acceptance testing, packaging, or production. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_scratch_orgs_def_file.htm> for all the option you can specify in the definition file.", "name": "definition-file", "summary": "Path to a scratch org definition file.", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "target-dev-hub": { "char": "v", "description": "Overrides the value of the target-dev-hub configuration variable, if set.", "name": "target-dev-hub", "noCacheDefault": true, "required": true, "summary": "Username or alias of the Dev Hub org.", "hasDynamicHelp": true, "multiple": false, "type": "option" }, "no-ancestors": { "char": "c", "helpGroup": "Packaging", "name": "no-ancestors", "summary": "Don't include second-generation managed package (2GP) ancestors in the scratch org.", "allowNo": false, "type": "boolean" }, "edition": { "char": "e", "description": "The editions that begin with \"partner-\" are available only if the Dev Hub org is a Partner Business Org.", "exclusive": [ "snapshot", "source-org" ], "helpGroup": "Definition File Override", "name": "edition", "summary": "Salesforce edition of the scratch org. Overrides the value of the \"edition\" option in the definition file, if set.", "hasDynamicHelp": false, "multiple": false, "options": [ "developer", "enterprise", "group", "professional", "partner-developer", "partner-enterprise", "partner-group",