Skip to content

Commit

Permalink
fix: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
RodEsp committed Mar 15, 2021
1 parent 882014d commit 5033f35
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,12 +262,16 @@ OPTIONS
this command invocation
DESCRIPTION
Authorize a Salesforce org using an SFDX auth URL stored within a file. The file must have the format
"force://<refreshToken>@<instanceUrl>" or "force://<clientId>:<clientSecret>:<refreshToken>@<instanceUrl>".
The file must contain only the URL or be a JSON file that has a top-level property named sfdxAuthUrl or be a JSON file with the same format as the `sfdx force:org:display --verbose --json` command.
Use this command to get the SFDX auth URL for a Dev Hub org you have already authorized:
Authorize a Salesforce org using an SFDX auth URL stored within a file. The URL must have the format \"%s\" or \"%s\".
You have three options when creating the auth file. The easiest option is to redirect the output of the `sfdx force:org:display --verbose --json` command into a file.
For example, using an org you have already authorized:
$ sfdx force:org:display -u <DevHub> --verbose
$ sfdx force:org:display -u <DevHub> --verbose --json > authFile.json
$ sfdx auth:sfdxurl:store -f authFile.json
The resulting JSON file contains the URL in the sfdxAuthUrl property inside of a results object.
You can also create a JSON file that has a top-level property named sfdxAuthUrl whose value is the auth URL.
Finally, you can create a normal text file that includes just the URL and nothing else.
ALIASES
$ sfdx force:auth:sfdxurl:store
Expand Down
2 changes: 1 addition & 1 deletion messages/sfdxurl.store.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"description": "authorize an org using an SFDX auth URL\nAuthorize a Salesforce org using an SFDX auth URL stored within a file. The file must have the format \"%s\" or \"%s\".\nThe file must contain only the URL or be a JSON file that has a top-level property named sfdxAuthUrl or be a JSON file with the same format as the `sfdx force:org:display --verbose --json` command.\nUse this command to get the SFDX auth URL for a Dev Hub org you have already authorized:\n\n $ sfdx force:org:display -u <DevHub> --verbose",
"description": "Authorize an org using an SFDX auth URL\nAuthorize a Salesforce org using an SFDX auth URL stored within a file. The URL must have the format \"%s\" or \"%s\".\nYou have three options when creating the auth file. The easiest option is to redirect the output of the `sfdx force:org:display --verbose --json` command into a file.\nFor example, using an org you have already authorized:\n\n $ sfdx force:org:display -u <DevHub> --verbose --json > authFile.json\n $ sfdx auth:sfdxurl:store -f authFile.json\n\nThe resulting JSON file contains the URL in the sfdxAuthUrl property inside of a results object.\nYou can also create a JSON file that has a top-level property named sfdxAuthUrl whose value is the auth URL.\nFinally, you can create a normal text file that includes just the URL and nothing else.",
"file": "path to a file containing the sfdx url",
"examples": [
"sfdx auth:sfdxurl:store -f <path to sfdxAuthUrl file>",
Expand Down

0 comments on commit 5033f35

Please sign in to comment.