Skip to content

Commit 43f9354

Browse files
WillieRuemmeleWillieRuemmele
authored
Merge pull request #2 from salesforcecli/wr/addCommands
Wr/add commands
2 parents 7fba9af + c1fa918 commit 43f9354

File tree

24 files changed

+2969
-1415
lines changed

24 files changed

+2969
-1415
lines changed

‎.circleci/config.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
version: 2.1
33
orbs:
4-
release-management: salesforce/npm-release-management@3
4+
release-management: salesforce/npm-release-management@4
55

66
workflows:
77
version: 2
@@ -18,6 +18,7 @@ workflows:
1818
name: node-12
1919
- release-management/release-package:
2020
sign: true
21+
github-release: true
2122
requires:
2223
- node-latest
2324
filters:

‎COMMANDS.md

Lines changed: 174 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,195 @@
22

33
A list of the available commands
44

5-
- [`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)
5+
- sfdx force:user:list [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
66

7-
## `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]`
7+
## `sfdx force:user:list [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
88

9-
print a greeting and your org IDs
9+
lists all users of a scratch org
1010

1111
```
1212
USAGE
13-
$ sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
13+
$ sfdx force:user:list [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
1414
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
1515
1616
OPTIONS
17-
-f, --force example boolean flag
18-
-n, --name=name name to print
17+
-u, --targetusername=targetusername username or alias for the
18+
target org; overrides
19+
default target org
1920
20-
-u, --targetusername=targetusername username or alias for the target
21-
org; overrides default target org
21+
-v, --targetdevhubusername=targetdevhubusername username or alias for the
22+
dev hub org; overrides
23+
default dev hub org
2224
23-
-v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub
24-
org; overrides default dev hub org
25+
--apiversion=apiversion override the api version
26+
used for api requests made
27+
by this command
2528
26-
--apiversion=apiversion override the api version used for
27-
api requests made by this command
29+
--json format output as json
30+
31+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging
32+
level for this command
33+
invocation
34+
35+
EXAMPLES
36+
sfdx force:user:list
37+
sfdx force:user:list -u me@my.org --json
38+
sfdx force:user:list --json > tmp/MyUserList.json
39+
```
40+
41+
- sfdx force:user:display [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
42+
43+
## `sfdx force:user:display [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
44+
45+
displays information about a user of a scratch org
46+
47+
```
48+
USAGE
49+
$ sfdx force:user:display [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
50+
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
51+
52+
OPTIONS
53+
-u, --targetusername=targetusername username or alias for the
54+
target org; overrides
55+
default target org
56+
57+
-v, --targetdevhubusername=targetdevhubusername username or alias for the
58+
dev hub org; overrides
59+
default dev hub org
60+
61+
--apiversion=apiversion override the api version
62+
used for api requests made
63+
by this command
2864
2965
--json format output as json
3066
31-
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
32-
this command invocation
67+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging
68+
level for this command
69+
invocation
3370
3471
EXAMPLES
35-
$ sfdx hello:org --targetusername myOrg@example.com --targetdevhubusername devhub@org.com
36-
Hello world! This is org: MyOrg and I will be around until Tue Mar 20 2018!
37-
My hub org id is: 00Dxx000000001234
72+
sfdx force:user:display
73+
sfdx force:user:display -u me@my.org --json
74+
```
75+
76+
- 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]
77+
78+
## `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]`
79+
80+
create a user for a scratch org
81+
82+
```USAGE
83+
$ sfdx force:user:create [name=value...] [-a <string>] [-f <string>] [-v <string>] [-u <string>] [--apiversion
84+
<string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
85+
86+
OPTIONS
87+
-a, --alias=alias set an alias for the created
88+
username to reference within
89+
the CLI
90+
91+
-f, --definitionfile=definitionfile file path to a user
92+
definition
93+
94+
-u, --targetusername=targetusername username or alias for the
95+
target org; overrides
96+
default target org
97+
98+
-v, --targetdevhubusername=targetdevhubusername username or alias for the
99+
dev hub org; overrides
100+
default dev hub org
101+
102+
--apiversion=apiversion override the api version
103+
used for api requests made
104+
by this command
105+
106+
--json format output as json
107+
108+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging
109+
level for this command
110+
invocation
111+
112+
EXAMPLES
113+
sfdx force:user:create
114+
sfdx force:user:create -a testuser1 -f config/project-user-def.json
115+
sfdx force:user:create username=testuser1@my.org email=me@my.org permsets=DreamHouse
116+
sfdx force:user:create -f config/project-user-def.json email=me@my.org generatepassword=true
117+
```
38118

39-
$ sfdx hello:org --name myname --targetusername myOrg@example.com
40-
Hello myname! This is org: MyOrg and I will be around until Tue Mar 20 2018!
119+
- 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]
120+
121+
## `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]`
122+
123+
generate a password for scratch org users
124+
125+
```
126+
USAGE
127+
$ sfdx force:user:password:generate [-o <array>] [-v <string>] [-u <string>] [--apiversion <string>] [--json]
128+
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
129+
130+
OPTIONS
131+
-o, --onbehalfof=onbehalfof comma-separated list of
132+
usernames or aliases to
133+
assign the password to
134+
135+
-u, --targetusername=targetusername username or alias for the
136+
target org; overrides
137+
default target org
138+
139+
-v, --targetdevhubusername=targetdevhubusername username or alias for the
140+
dev hub org; overrides
141+
default dev hub org
142+
143+
--apiversion=apiversion override the api version
144+
used for api requests made
145+
by this command
146+
147+
--json format output as json
148+
149+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging
150+
level for this command
151+
invocation
152+
153+
EXAMPLES
154+
sfdx force:user:password:generate
155+
sfdx force:user:password:generate -u me@my.org --json
156+
sfdx force:user:password:generate -o "user1@my.org,user2@my.org,user3@my.org"
157+
```
158+
159+
- 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]
160+
161+
## `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]`
162+
163+
assign a permission set to one or more users of an org
164+
165+
```
166+
USAGE
167+
$ sfdx force:user:permset:assign -n <string> [-o <array>] [-u <string>] [--apiversion <string>] [--json]
168+
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
169+
170+
OPTIONS
171+
-n, --permsetname=permsetname (required) the name of the
172+
permission set to assign
173+
174+
-o, --onbehalfof=onbehalfof comma-separated list of
175+
usernames or aliases to
176+
assign the permission set to
177+
178+
-u, --targetusername=targetusername username or alias for the
179+
target org; overrides
180+
default target org
181+
182+
--apiversion=apiversion override the api version
183+
used for api requests made
184+
by this command
185+
186+
--json format output as json
187+
188+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging
189+
level for this command
190+
invocation
191+
192+
EXAMPLES
193+
sfdx force:user:permset:assign -n DreamHouse
194+
sfdx force:user:permset:assign -n DreamHouse -u me@my.org
195+
sfdx force:user:permset:assign -n DreamHouse -o "user1@my.org,user2,user3"
41196
```

0 commit comments

Comments
 (0)