@simplysf/simply 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/README.md +233 -17
- package/npm-shrinkwrap.json +2 -2
- package/oclif.manifest.json +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -1,17 +1,233 @@
|
|
|
1
|
-
# simply
|
|
2
|
-
|
|
3
|
-
[](https://www.npmjs.com/package/@simplysf/simply) [](https://npmjs.org/package/@simplysf/simply) [](https://raw.githubusercontent.com/SimplySF/simply/main/LICENSE.txt)
|
|
4
|
-
|
|
5
|
-
## Install
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
sf plugins install @simplysf/simply
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Issues
|
|
12
|
-
|
|
13
|
-
Please report any issues at https://github.com/SimplySF/simply/issues
|
|
14
|
-
|
|
15
|
-
## Commands
|
|
16
|
-
|
|
17
|
-
<!-- commands -->
|
|
1
|
+
# simply
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@simplysf/simply) [](https://npmjs.org/package/@simplysf/simply) [](https://raw.githubusercontent.com/SimplySF/simply/main/LICENSE.txt)
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
sf plugins install @simplysf/simply
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Issues
|
|
12
|
+
|
|
13
|
+
Please report any issues at https://github.com/SimplySF/simply/issues
|
|
14
|
+
|
|
15
|
+
## Commands
|
|
16
|
+
|
|
17
|
+
<!-- commands -->
|
|
18
|
+
* [`sf simply data file upload`](#sf-simply-data-file-upload)
|
|
19
|
+
* [`sf simply data files upload`](#sf-simply-data-files-upload)
|
|
20
|
+
* [`sf simply package dependencies install`](#sf-simply-package-dependencies-install)
|
|
21
|
+
* [`sf simply package version cleanup`](#sf-simply-package-version-cleanup)
|
|
22
|
+
|
|
23
|
+
## `sf simply data file upload`
|
|
24
|
+
|
|
25
|
+
Upload a file to a Salesforce org.
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
USAGE
|
|
29
|
+
$ sf simply data file upload --file-path <value> -o <value> [--json] [--api-version <value>] [--first-publish-location-id
|
|
30
|
+
<value>] [--title <value>]
|
|
31
|
+
|
|
32
|
+
FLAGS
|
|
33
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the
|
|
34
|
+
`target-org` configuration variable is already set.
|
|
35
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
36
|
+
--file-path=<value> (required) Path to the file to upload.
|
|
37
|
+
--first-publish-location-id=<value> Specify a record Id that the file should be linked to.
|
|
38
|
+
--title=<value> Specify the title for the file being uploaded.
|
|
39
|
+
|
|
40
|
+
GLOBAL FLAGS
|
|
41
|
+
--json Format output as json.
|
|
42
|
+
|
|
43
|
+
DESCRIPTION
|
|
44
|
+
Upload a file to a Salesforce org.
|
|
45
|
+
|
|
46
|
+
Uploads a file to a Salesforce org.
|
|
47
|
+
|
|
48
|
+
EXAMPLES
|
|
49
|
+
$ sf simply data file upload --file-path fileToUpload.txt --target-org myTargetOrg
|
|
50
|
+
|
|
51
|
+
$ sf simply data file upload --file-path fileToUpload.txt --first-publish-location-id 0019000000DmehK --target-org myTargetOrg
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
_See code: [@simplysf/simply-data](https://github.com/SimplySF/simply-data/blob/1.1.2/src/commands/simply/data/file/upload.ts)_
|
|
55
|
+
|
|
56
|
+
## `sf simply data files upload`
|
|
57
|
+
|
|
58
|
+
Upload files to a Salesforce org.
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
USAGE
|
|
62
|
+
$ sf simply data files upload --file-path <value> -o <value> [--json] [--api-version <value>] [--max-parallel-jobs
|
|
63
|
+
<value>]
|
|
64
|
+
|
|
65
|
+
FLAGS
|
|
66
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
67
|
+
configuration variable is already set.
|
|
68
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
69
|
+
--file-path=<value> (required) Path to the csv file that specifies the upload.
|
|
70
|
+
--max-parallel-jobs=<value> [default: 1] Maximum number of parallel jobs.
|
|
71
|
+
|
|
72
|
+
GLOBAL FLAGS
|
|
73
|
+
--json Format output as json.
|
|
74
|
+
|
|
75
|
+
DESCRIPTION
|
|
76
|
+
Upload files to a Salesforce org.
|
|
77
|
+
|
|
78
|
+
Uploads files specified by a csv to a Salesforce org. By default, the plugin uses the REST API for the upload as the
|
|
79
|
+
Bulk API is limited in its payload size. This means that each file will use one REST API request.
|
|
80
|
+
|
|
81
|
+
EXAMPLES
|
|
82
|
+
$ sf simply data files upload --file-path filesToUpload.csv --target-org myTargetOrg
|
|
83
|
+
|
|
84
|
+
$ sf simply data files upload --file-path filesToUpload.csv --max-parallel-jobs 5 --target-org myTargetOrg
|
|
85
|
+
|
|
86
|
+
FLAG DESCRIPTIONS
|
|
87
|
+
--file-path=<value> Path to the csv file that specifies the upload.
|
|
88
|
+
|
|
89
|
+
The csv file must specify the columns PathOnClient and Title. Optionally, a FirstPublishLocationId can be specified
|
|
90
|
+
to have it linked directly to a Salesforce record after upload.
|
|
91
|
+
|
|
92
|
+
--max-parallel-jobs=<value> Maximum number of parallel jobs.
|
|
93
|
+
|
|
94
|
+
By default the plugin will only process a single file upload at a time. You can increase this value to allow for
|
|
95
|
+
quasi concurrent uploads. Please note that setting this value too high can cause performance issues.
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
_See code: [@simplysf/simply-data](https://github.com/SimplySF/simply-data/blob/1.1.2/src/commands/simply/data/files/upload.ts)_
|
|
99
|
+
|
|
100
|
+
## `sf simply package dependencies install`
|
|
101
|
+
|
|
102
|
+
Install package dependencies for a Salesforce project.
|
|
103
|
+
|
|
104
|
+
```
|
|
105
|
+
USAGE
|
|
106
|
+
$ sf simply package dependencies install -o <value> [--json] [-a all|package] [--api-version <value>] [-z <value>] [-i All|Delta] [-k
|
|
107
|
+
<value>] [-r] [-b <value>] [-s AllUsers|AdminsOnly] [-v <value>] [-t DeprecateOnly|Mixed|Delete] [-w <value>]
|
|
108
|
+
|
|
109
|
+
FLAGS
|
|
110
|
+
-a, --apex-compile=<option> Compile all Apex in the org and package, or only Apex in the package; unlocked
|
|
111
|
+
packages only.
|
|
112
|
+
<options: all|package>
|
|
113
|
+
-b, --publish-wait=<value> [default: [object Object]] Maximum number of minutes to wait for the Subscriber
|
|
114
|
+
Package Version ID to become available in the target org before canceling the
|
|
115
|
+
install request.
|
|
116
|
+
-i, --install-type=<option> [default: Delta] Install all packages or only deltas.
|
|
117
|
+
<options: All|Delta>
|
|
118
|
+
-k, --installation-key=<value>... Installation key for key-protected packages
|
|
119
|
+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
|
|
120
|
+
configuration variable is already set.
|
|
121
|
+
-r, --no-prompt Don't prompt for confirmation.
|
|
122
|
+
-s, --security-type=<option> [default: AdminsOnly] Security access type for the installed package. (deprecation
|
|
123
|
+
notice: The default --security-type value will change from AllUsers to AdminsOnly
|
|
124
|
+
in v47.0 or later.)
|
|
125
|
+
<options: AllUsers|AdminsOnly>
|
|
126
|
+
-t, --upgrade-type=<option> [default: Mixed] Upgrade type for the package installation; available only for
|
|
127
|
+
unlocked packages.
|
|
128
|
+
<options: DeprecateOnly|Mixed|Delete>
|
|
129
|
+
-v, --target-dev-hub=<value> Username or alias of the Dev Hub org.
|
|
130
|
+
-w, --wait=<value> [default: [object Object]] Number of minutes to wait for installation status.
|
|
131
|
+
-z, --branch=<value> Package branch to consider when specifiying a Package/VersionNumber combination
|
|
132
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
133
|
+
|
|
134
|
+
GLOBAL FLAGS
|
|
135
|
+
--json Format output as json.
|
|
136
|
+
|
|
137
|
+
DESCRIPTION
|
|
138
|
+
Install package dependencies for a Salesforce project.
|
|
139
|
+
|
|
140
|
+
Installs all specified package dependencies in a Salesforce DX project using the sfdx-project.json definition.
|
|
141
|
+
|
|
142
|
+
EXAMPLES
|
|
143
|
+
$ sf simply package dependencies install --target-org myTargetOrg --target-dev-hub myTargetDevHub
|
|
144
|
+
|
|
145
|
+
$ sf simply package dependencies install --target-org myTargetOrg --target-dev-hub myTargetDevHub --installation-key "MyPackage1Alias:MyPackage1Key"
|
|
146
|
+
|
|
147
|
+
$ sf simply package dependencies install --target-org myTargetOrg --target-dev-hub myTargetDevHub --installation-key "MyPackage1Alias:MyPackage1Key" --installation-key "MyPackage2Alias:MyPackage2Key"
|
|
148
|
+
|
|
149
|
+
FLAG DESCRIPTIONS
|
|
150
|
+
-a, --apex-compile=all|package
|
|
151
|
+
|
|
152
|
+
Compile all Apex in the org and package, or only Apex in the package; unlocked packages only.
|
|
153
|
+
|
|
154
|
+
Applies to unlocked packages only. Specifies whether to compile all Apex in the org and package, or only the Apex in
|
|
155
|
+
the package.
|
|
156
|
+
|
|
157
|
+
For package installs into production orgs, or any org that has Apex Compile on Deploy enabled, the platform compiles
|
|
158
|
+
all Apex in the org after the package install or upgrade operation completes.
|
|
159
|
+
|
|
160
|
+
This approach assures that package installs and upgrades don’t impact the performance of an org, and is done even if
|
|
161
|
+
--apex-compile package is specified.
|
|
162
|
+
|
|
163
|
+
-i, --install-type=All|Delta Install all packages or only deltas.
|
|
164
|
+
|
|
165
|
+
If 'All' is specified, then all packages specified in package dependencies are installed, regardless of if the
|
|
166
|
+
version already is installed in the org. If 'Delta' is specified, then only packages that differ from what is
|
|
167
|
+
installed in the org will be installed.
|
|
168
|
+
|
|
169
|
+
-k, --installation-key=<value>... Installation key for key-protected packages
|
|
170
|
+
|
|
171
|
+
Installation key for key-protected packages in the key:value format of SubscriberPackageVersionId:Key
|
|
172
|
+
|
|
173
|
+
-r, --no-prompt Don't prompt for confirmation.
|
|
174
|
+
|
|
175
|
+
Allows the following without an explicit confirmation response: 1) Remote Site Settings and Content Security Policy
|
|
176
|
+
websites to send or receive data, and 2) --upgrade-type Delete to proceed.
|
|
177
|
+
|
|
178
|
+
-t, --upgrade-type=DeprecateOnly|Mixed|Delete
|
|
179
|
+
|
|
180
|
+
Upgrade type for the package installation; available only for unlocked packages.
|
|
181
|
+
|
|
182
|
+
For package upgrades, specifies whether to mark all removed components as deprecated (DeprecateOnly), to delete
|
|
183
|
+
removed components that can be safely deleted and deprecate the others (Mixed), or to delete all removed components,
|
|
184
|
+
except for custom objects and custom fields, that don't have dependencies (Delete). The default is Mixed. Can
|
|
185
|
+
specify DeprecateOnly or Delete only for unlocked package upgrades.
|
|
186
|
+
|
|
187
|
+
-z, --branch=<value> Package branch to consider when specifiying a Package/VersionNumber combination
|
|
188
|
+
|
|
189
|
+
For dependencies specified by Package/VersionNumber combination, you can specify the branch group of builds to work
|
|
190
|
+
from by entering the branch build name. If not specified, the builds from NULL branch will be considered.
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
_See code: [@simplysf/simply-package](https://github.com/SimplySF/simply-package/blob/1.1.2/src/commands/simply/package/dependencies/install.ts)_
|
|
194
|
+
|
|
195
|
+
## `sf simply package version cleanup`
|
|
196
|
+
|
|
197
|
+
Cleanup package versions.
|
|
198
|
+
|
|
199
|
+
```
|
|
200
|
+
USAGE
|
|
201
|
+
$ sf simply package version cleanup -s <value> -p <value> -v <value> [--json] [--api-version <value>]
|
|
202
|
+
|
|
203
|
+
FLAGS
|
|
204
|
+
-p, --package=<value> (required) Package Id
|
|
205
|
+
-s, --matcher=<value> (required) MAJOR.MINOR.PATCH
|
|
206
|
+
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub`
|
|
207
|
+
configuration variable is already set.
|
|
208
|
+
--api-version=<value> Override the api version used for api requests made by this command
|
|
209
|
+
|
|
210
|
+
GLOBAL FLAGS
|
|
211
|
+
--json Format output as json.
|
|
212
|
+
|
|
213
|
+
DESCRIPTION
|
|
214
|
+
Cleanup package versions.
|
|
215
|
+
|
|
216
|
+
Delete package versions for a given package provided a MAJOR.MINOR.PATCH matcher. Does not delete released pacakge
|
|
217
|
+
versions.
|
|
218
|
+
|
|
219
|
+
EXAMPLES
|
|
220
|
+
$ sf simply package version cleanup --package 0Hoxx00000000CqCAI --matcher 2.10.0 --target-dev-hub myDevHub
|
|
221
|
+
|
|
222
|
+
FLAG DESCRIPTIONS
|
|
223
|
+
-p, --package=<value> Package Id
|
|
224
|
+
|
|
225
|
+
The 0Ht Package Id that you wish to cleanup versions for.
|
|
226
|
+
|
|
227
|
+
-s, --matcher=<value> MAJOR.MINOR.PATCH
|
|
228
|
+
|
|
229
|
+
The MAJOR.MINOR.PATCH matcher that should be used to find package versions to delete.
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
_See code: [@simplysf/simply-package](https://github.com/SimplySF/simply-package/blob/1.1.2/src/commands/simply/package/version/cleanup.ts)_
|
|
233
|
+
<!-- commandsstop -->
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@simplysf/simply",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@simplysf/simply",
|
|
9
|
-
"version": "1.
|
|
9
|
+
"version": "1.1.0",
|
|
10
10
|
"license": "BSD-3-Clause",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"@simplysf/simply-data": "1.1.2",
|
package/oclif.manifest.json
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@simplysf/simply",
|
|
3
3
|
"description": "Salesforce CLI Plugins created by @SimplySF",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.1.0",
|
|
5
5
|
"author": "@ClayChipps",
|
|
6
6
|
"homepage": "https://github.com/SimplySF/simply",
|
|
7
7
|
"bugs": "https://github.com/SimplySF/simply/issues",
|