generated from salesforcecli/plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: once through fixing up config files/readme/commands
- Loading branch information
1 parent
22f2252
commit b7dcbe4
Showing
16 changed files
with
419 additions
and
144 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,40 +2,195 @@ | |
|
|
||
| A list of the available commands | ||
|
|
||
| - [`sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-helloorg--n-string--f--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) | ||
| - sfdx force:user:list [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] | ||
|
|
||
| ## `sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
| ## `sfdx force:user:list [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
|
||
| print a greeting and your org IDs | ||
| lists all users of a scratch org | ||
|
|
||
| ``` | ||
| USAGE | ||
| $ sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel | ||
| $ sfdx force:user:list [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel | ||
| trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] | ||
| OPTIONS | ||
| -f, --force example boolean flag | ||
| -n, --name=name name to print | ||
| -u, --targetusername=targetusername username or alias for the | ||
| target org; overrides | ||
| default target org | ||
| -u, --targetusername=targetusername username or alias for the target | ||
| org; overrides default target org | ||
| -v, --targetdevhubusername=targetdevhubusername username or alias for the | ||
| dev hub org; overrides | ||
| default dev hub org | ||
| -v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub | ||
| org; overrides default dev hub org | ||
| --apiversion=apiversion override the api version | ||
| used for api requests made | ||
| by this command | ||
| --apiversion=apiversion override the api version used for | ||
| api requests made by this command | ||
| --json format output as json | ||
| --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging | ||
| level for this command | ||
| invocation | ||
| EXAMPLES | ||
| sfdx force:user:list | ||
| sfdx force:user:list -u [email protected] --json | ||
| sfdx force:user:list --json > tmp/MyUserList.json | ||
| ``` | ||
|
|
||
| - sfdx force:user:display [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] | ||
|
|
||
| ## `sfdx force:user:display [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
|
||
| displays information about a user of a scratch org | ||
|
|
||
| ``` | ||
| USAGE | ||
| $ sfdx force:user:display [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel | ||
| trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] | ||
| OPTIONS | ||
| -u, --targetusername=targetusername username or alias for the | ||
| target org; overrides | ||
| default target org | ||
| -v, --targetdevhubusername=targetdevhubusername username or alias for the | ||
| dev hub org; overrides | ||
| default dev hub org | ||
| --apiversion=apiversion override the api version | ||
| used for api requests made | ||
| by this command | ||
| --json format output as json | ||
| --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for | ||
| this command invocation | ||
| --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging | ||
| level for this command | ||
| invocation | ||
| EXAMPLES | ||
| $ sfdx hello:org --targetusername [email protected] --targetdevhubusername [email protected] | ||
| Hello world! This is org: MyOrg and I will be around until Tue Mar 20 2018! | ||
| My hub org id is: 00Dxx000000001234 | ||
| sfdx force:user:display | ||
| sfdx force:user:display -u [email protected] --json | ||
| ``` | ||
|
|
||
| - sfdx force:user:create [name=value...] [-a <string>] [-f <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] | ||
|
|
||
| ## `sfdx force:user:create [name=value...] [-a <string>] [-f <string>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
|
||
| create a user for a scratch org | ||
|
|
||
| ```USAGE | ||
| $ sfdx force:user:create [name=value...] [-a <string>] [-f <string>] [-v <string>] [-u <string>] [--apiversion | ||
| <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] | ||
| OPTIONS | ||
| -a, --alias=alias set an alias for the created | ||
| username to reference within | ||
| the CLI | ||
| -f, --definitionfile=definitionfile file path to a user | ||
| definition | ||
| -u, --targetusername=targetusername username or alias for the | ||
| target org; overrides | ||
| default target org | ||
| -v, --targetdevhubusername=targetdevhubusername username or alias for the | ||
| dev hub org; overrides | ||
| default dev hub org | ||
| --apiversion=apiversion override the api version | ||
| used for api requests made | ||
| by this command | ||
| --json format output as json | ||
| --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging | ||
| level for this command | ||
| invocation | ||
| EXAMPLES | ||
| sfdx force:user:create | ||
| sfdx force:user:create -a testuser1 -f config/project-user-def.json | ||
| sfdx force:user:create [email protected] [email protected] permsets=DreamHouse | ||
| sfdx force:user:create -f config/project-user-def.json [email protected] generatepassword=true | ||
| ``` | ||
|
|
||
| $ sfdx hello:org --name myname --targetusername [email protected] | ||
| Hello myname! This is org: MyOrg and I will be around until Tue Mar 20 2018! | ||
| - force:user:password:generate [-o <array>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] | ||
|
|
||
| ## `force:user:password:generate [-o <array>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
|
||
| generate a password for scratch org users | ||
|
|
||
| ``` | ||
| USAGE | ||
| $ sfdx force:user:password:generate [-o <array>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] | ||
| [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] | ||
| OPTIONS | ||
| -o, --onbehalfof=onbehalfof comma-separated list of | ||
| usernames or aliases to | ||
| assign the password to | ||
| -u, --targetusername=targetusername username or alias for the | ||
| target org; overrides | ||
| default target org | ||
| -v, --targetdevhubusername=targetdevhubusername username or alias for the | ||
| dev hub org; overrides | ||
| default dev hub org | ||
| --apiversion=apiversion override the api version | ||
| used for api requests made | ||
| by this command | ||
| --json format output as json | ||
| --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging | ||
| level for this command | ||
| invocation | ||
| EXAMPLES | ||
| sfdx force:user:password:generate | ||
| sfdx force:user:password:generate -u [email protected] --json | ||
| sfdx force:user:password:generate -o "[email protected],[email protected],[email protected]" | ||
| ``` | ||
|
|
||
| - sfdx force:user:permset:assign -n <string> [-o <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] | ||
|
|
||
| ## `sfdx force:user:permset:assign -n <string> [-o <array>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` | ||
|
|
||
| assign a permission set to one or more users of an org | ||
|
|
||
| ``` | ||
| USAGE | ||
| $ sfdx force:user:permset:assign -n <string> [-o <array>] [-u <string>] [--apiversion <string>] [--json] | ||
| [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] | ||
| OPTIONS | ||
| -n, --permsetname=permsetname (required) the name of the | ||
| permission set to assign | ||
| -o, --onbehalfof=onbehalfof comma-separated list of | ||
| usernames or aliases to | ||
| assign the permission set to | ||
| -u, --targetusername=targetusername username or alias for the | ||
| target org; overrides | ||
| default target org | ||
| --apiversion=apiversion override the api version | ||
| used for api requests made | ||
| by this command | ||
| --json format output as json | ||
| --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging | ||
| level for this command | ||
| invocation | ||
| EXAMPLES | ||
| sfdx force:user:permset:assign -n DreamHouse | ||
| sfdx force:user:permset:assign -n DreamHouse -u [email protected] | ||
| sfdx force:user:permset:assign -n DreamHouse -o "[email protected],user2,user3" | ||
| ``` | ||
Oops, something went wrong.