@super-protocol/sp-cli 0.0.2-alpha.1 → 0.0.2-beta.10
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/README.md +145 -260
- package/dist/commands/account/info.d.ts +21 -0
- package/dist/commands/account/info.js +43 -0
- package/dist/commands/auth/login.d.ts +2 -10
- package/dist/commands/auth/login.js +25 -75
- package/dist/commands/base.d.ts +2 -4
- package/dist/commands/base.js +8 -10
- package/dist/commands/config/add.js +9 -5
- package/dist/commands/config/base.d.ts +4 -3
- package/dist/commands/config/base.js +12 -14
- package/dist/commands/config/create.js +4 -4
- package/dist/commands/config/list.js +2 -2
- package/dist/commands/config/use.js +5 -3
- package/dist/commands/files/download.d.ts +15 -0
- package/dist/commands/files/download.js +53 -0
- package/dist/commands/files/upload.d.ts +18 -0
- package/dist/commands/files/upload.js +77 -0
- package/dist/commands/storage/base.d.ts +13 -0
- package/dist/commands/storage/base.js +123 -0
- package/dist/commands/storage/create.d.ts +11 -0
- package/dist/commands/storage/create.js +53 -0
- package/dist/commands/storage/select.d.ts +9 -0
- package/dist/commands/storage/select.js +46 -0
- package/dist/commands/storage/update.d.ts +14 -0
- package/dist/commands/storage/update.js +187 -0
- package/dist/config/config-file.schema.d.ts +4 -4
- package/dist/config/config-file.schema.js +1 -1
- package/dist/config/config.schema.d.ts +16 -15
- package/dist/config/config.schema.js +2 -10
- package/dist/config/resource.schema.d.ts +31 -0
- package/dist/config/resource.schema.js +14 -0
- package/dist/constants.d.ts +2 -0
- package/dist/constants.js +2 -0
- package/dist/errors.d.ts +2 -0
- package/dist/errors.js +2 -0
- package/dist/lib/container.d.ts +6 -7
- package/dist/lib/container.js +26 -26
- package/dist/managers/account-manager.js +13 -3
- package/dist/managers/config-file-manager.d.ts +1 -1
- package/dist/managers/config-file-manager.js +13 -8
- package/dist/middlewares/auth-middleware.js +5 -1
- package/dist/services/auth.service.d.ts +24 -0
- package/dist/services/auth.service.js +93 -0
- package/dist/services/storage.service.d.ts +71 -0
- package/dist/services/storage.service.js +308 -0
- package/dist/utils/helper.d.ts +5 -0
- package/dist/utils/helper.js +22 -0
- package/dist/utils/progress.d.ts +8 -0
- package/dist/utils/progress.js +27 -0
- package/oclif.manifest.json +368 -131
- package/package.json +12 -6
package/README.md
CHANGED
|
@@ -21,7 +21,7 @@ $ npm install -g @super-protocol/sp-cli
|
|
|
21
21
|
$ sp COMMAND
|
|
22
22
|
running command...
|
|
23
23
|
$ sp (--version)
|
|
24
|
-
@super-protocol/sp-cli/0.0.2-
|
|
24
|
+
@super-protocol/sp-cli/0.0.2-beta.10 linux-x64 node-v22.21.1
|
|
25
25
|
$ sp --help [COMMAND]
|
|
26
26
|
USAGE
|
|
27
27
|
$ sp COMMAND
|
|
@@ -30,6 +30,7 @@ USAGE
|
|
|
30
30
|
<!-- usagestop -->
|
|
31
31
|
# Commands
|
|
32
32
|
<!-- commands -->
|
|
33
|
+
* [`sp account info`](#sp-account-info)
|
|
33
34
|
* [`sp auth login`](#sp-auth-login)
|
|
34
35
|
* [`sp auth me`](#sp-auth-me)
|
|
35
36
|
* [`sp base`](#sp-base)
|
|
@@ -41,17 +42,27 @@ USAGE
|
|
|
41
42
|
* [`sp config list`](#sp-config-list)
|
|
42
43
|
* [`sp config show`](#sp-config-show)
|
|
43
44
|
* [`sp config use`](#sp-config-use)
|
|
45
|
+
* [`sp files download RESOURCEFILE LOCALDIRECTORY`](#sp-files-download-resourcefile-localdirectory)
|
|
46
|
+
* [`sp files upload PATH`](#sp-files-upload-path)
|
|
44
47
|
* [`sp help [COMMAND]`](#sp-help-command)
|
|
45
|
-
* [`sp
|
|
46
|
-
* [`sp
|
|
47
|
-
* [`sp
|
|
48
|
-
* [`sp
|
|
49
|
-
* [`sp
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
48
|
+
* [`sp login`](#sp-login)
|
|
49
|
+
* [`sp storage base`](#sp-storage-base)
|
|
50
|
+
* [`sp storage create`](#sp-storage-create)
|
|
51
|
+
* [`sp storage select`](#sp-storage-select)
|
|
52
|
+
* [`sp storage update`](#sp-storage-update)
|
|
53
|
+
|
|
54
|
+
## `sp account info`
|
|
55
|
+
|
|
56
|
+
```
|
|
57
|
+
USAGE
|
|
58
|
+
$ sp account info [--json] [--config <value>]
|
|
59
|
+
|
|
60
|
+
GLOBAL FLAGS
|
|
61
|
+
--config=<value> Specify config file.
|
|
62
|
+
--json Format output as json.
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
_See code: [src/commands/account/info.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/account/info.ts)_
|
|
55
66
|
|
|
56
67
|
## `sp auth login`
|
|
57
68
|
|
|
@@ -59,49 +70,49 @@ Authorization
|
|
|
59
70
|
|
|
60
71
|
```
|
|
61
72
|
USAGE
|
|
62
|
-
$ sp auth login [--json] [--config <value>]
|
|
73
|
+
$ sp auth login [--json] [--config <value>]
|
|
63
74
|
|
|
64
75
|
GLOBAL FLAGS
|
|
65
76
|
--config=<value> Specify config file.
|
|
66
77
|
--json Format output as json.
|
|
67
|
-
--url=<value> Specify provider base URL.
|
|
68
78
|
|
|
69
79
|
DESCRIPTION
|
|
70
80
|
Authorization
|
|
71
81
|
|
|
82
|
+
ALIASES
|
|
83
|
+
$ sp login
|
|
84
|
+
|
|
72
85
|
EXAMPLES
|
|
73
86
|
$ sp auth login
|
|
74
87
|
```
|
|
75
88
|
|
|
76
|
-
_See code: [src/commands/auth/login.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-
|
|
89
|
+
_See code: [src/commands/auth/login.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/auth/login.ts)_
|
|
77
90
|
|
|
78
91
|
## `sp auth me`
|
|
79
92
|
|
|
80
93
|
```
|
|
81
94
|
USAGE
|
|
82
|
-
$ sp auth me [--json] [--config <value>]
|
|
95
|
+
$ sp auth me [--json] [--config <value>]
|
|
83
96
|
|
|
84
97
|
GLOBAL FLAGS
|
|
85
98
|
--config=<value> Specify config file.
|
|
86
99
|
--json Format output as json.
|
|
87
|
-
--url=<value> Specify provider base URL.
|
|
88
100
|
```
|
|
89
101
|
|
|
90
|
-
_See code: [src/commands/auth/me.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-
|
|
102
|
+
_See code: [src/commands/auth/me.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/auth/me.ts)_
|
|
91
103
|
|
|
92
104
|
## `sp base`
|
|
93
105
|
|
|
94
106
|
```
|
|
95
107
|
USAGE
|
|
96
|
-
$ sp base [--json] [--config <value>]
|
|
108
|
+
$ sp base [--json] [--config <value>]
|
|
97
109
|
|
|
98
110
|
GLOBAL FLAGS
|
|
99
111
|
--config=<value> Specify config file.
|
|
100
112
|
--json Format output as json.
|
|
101
|
-
--url=<value> Specify provider base URL.
|
|
102
113
|
```
|
|
103
114
|
|
|
104
|
-
_See code: [src/commands/base.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-
|
|
115
|
+
_See code: [src/commands/base.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/base.ts)_
|
|
105
116
|
|
|
106
117
|
## `sp config`
|
|
107
118
|
|
|
@@ -109,12 +120,10 @@ Manage configuration configs
|
|
|
109
120
|
|
|
110
121
|
```
|
|
111
122
|
USAGE
|
|
112
|
-
$ sp config [--json]
|
|
123
|
+
$ sp config [--json]
|
|
113
124
|
|
|
114
125
|
GLOBAL FLAGS
|
|
115
|
-
--
|
|
116
|
-
--json Format output as json.
|
|
117
|
-
--url=<value> Specify provider base URL.
|
|
126
|
+
--json Format output as json.
|
|
118
127
|
|
|
119
128
|
DESCRIPTION
|
|
120
129
|
Manage configuration configs
|
|
@@ -133,7 +142,7 @@ EXAMPLES
|
|
|
133
142
|
$ sp config delete - Delete a configuration
|
|
134
143
|
```
|
|
135
144
|
|
|
136
|
-
_See code: [src/commands/config/index.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-
|
|
145
|
+
_See code: [src/commands/config/index.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/config/index.ts)_
|
|
137
146
|
|
|
138
147
|
## `sp config add [FILE]`
|
|
139
148
|
|
|
@@ -141,7 +150,7 @@ Import a configuration from a file
|
|
|
141
150
|
|
|
142
151
|
```
|
|
143
152
|
USAGE
|
|
144
|
-
$ sp config add [FILE] [--json] [
|
|
153
|
+
$ sp config add [FILE] [--json] [-n <value>] [-y]
|
|
145
154
|
|
|
146
155
|
ARGUMENTS
|
|
147
156
|
[FILE] Configuration file path to import
|
|
@@ -151,9 +160,7 @@ FLAGS
|
|
|
151
160
|
-y, --yes Automatically switch to imported configuration
|
|
152
161
|
|
|
153
162
|
GLOBAL FLAGS
|
|
154
|
-
--
|
|
155
|
-
--json Format output as json.
|
|
156
|
-
--url=<value> Specify provider base URL.
|
|
163
|
+
--json Format output as json.
|
|
157
164
|
|
|
158
165
|
DESCRIPTION
|
|
159
166
|
Import a configuration from a file
|
|
@@ -174,21 +181,19 @@ EXAMPLES
|
|
|
174
181
|
}
|
|
175
182
|
```
|
|
176
183
|
|
|
177
|
-
_See code: [src/commands/config/add.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-
|
|
184
|
+
_See code: [src/commands/config/add.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/config/add.ts)_
|
|
178
185
|
|
|
179
186
|
## `sp config base`
|
|
180
187
|
|
|
181
188
|
```
|
|
182
189
|
USAGE
|
|
183
|
-
$ sp config base [--json]
|
|
190
|
+
$ sp config base [--json]
|
|
184
191
|
|
|
185
192
|
GLOBAL FLAGS
|
|
186
|
-
--
|
|
187
|
-
--json Format output as json.
|
|
188
|
-
--url=<value> Specify provider base URL.
|
|
193
|
+
--json Format output as json.
|
|
189
194
|
```
|
|
190
195
|
|
|
191
|
-
_See code: [src/commands/config/base.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-
|
|
196
|
+
_See code: [src/commands/config/base.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/config/base.ts)_
|
|
192
197
|
|
|
193
198
|
## `sp config create`
|
|
194
199
|
|
|
@@ -196,7 +201,7 @@ Create a new configuration
|
|
|
196
201
|
|
|
197
202
|
```
|
|
198
203
|
USAGE
|
|
199
|
-
$ sp config create -n <value> [--json] [
|
|
204
|
+
$ sp config create -n <value> [--json] [-u <value>] [-y]
|
|
200
205
|
|
|
201
206
|
FLAGS
|
|
202
207
|
-n, --name=<value> (required) Configuration name
|
|
@@ -204,8 +209,7 @@ FLAGS
|
|
|
204
209
|
-y, --yes Switch to new config
|
|
205
210
|
|
|
206
211
|
GLOBAL FLAGS
|
|
207
|
-
--
|
|
208
|
-
--json Format output as json.
|
|
212
|
+
--json Format output as json.
|
|
209
213
|
|
|
210
214
|
DESCRIPTION
|
|
211
215
|
Create a new configuration
|
|
@@ -216,7 +220,7 @@ EXAMPLES
|
|
|
216
220
|
$ sp config create --name "Production" --url "https://api.dp.superprotocol.com"
|
|
217
221
|
```
|
|
218
222
|
|
|
219
|
-
_See code: [src/commands/config/create.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-
|
|
223
|
+
_See code: [src/commands/config/create.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/config/create.ts)_
|
|
220
224
|
|
|
221
225
|
## `sp config delete`
|
|
222
226
|
|
|
@@ -224,16 +228,14 @@ Delete a configuration file
|
|
|
224
228
|
|
|
225
229
|
```
|
|
226
230
|
USAGE
|
|
227
|
-
$ sp config delete [--json] [
|
|
231
|
+
$ sp config delete [--json] [-f] [-n <value>]
|
|
228
232
|
|
|
229
233
|
FLAGS
|
|
230
234
|
-f, --force Force deletion without confirmation
|
|
231
235
|
-n, --name=<value> Configuration name to delete
|
|
232
236
|
|
|
233
237
|
GLOBAL FLAGS
|
|
234
|
-
--
|
|
235
|
-
--json Format output as json.
|
|
236
|
-
--url=<value> Specify provider base URL.
|
|
238
|
+
--json Format output as json.
|
|
237
239
|
|
|
238
240
|
DESCRIPTION
|
|
239
241
|
Delete a configuration file
|
|
@@ -246,7 +248,7 @@ EXAMPLES
|
|
|
246
248
|
$ sp config delete --name "My Config" --force
|
|
247
249
|
```
|
|
248
250
|
|
|
249
|
-
_See code: [src/commands/config/delete.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-
|
|
251
|
+
_See code: [src/commands/config/delete.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/config/delete.ts)_
|
|
250
252
|
|
|
251
253
|
## `sp config list`
|
|
252
254
|
|
|
@@ -254,12 +256,10 @@ List all configurations
|
|
|
254
256
|
|
|
255
257
|
```
|
|
256
258
|
USAGE
|
|
257
|
-
$ sp config list [--json]
|
|
259
|
+
$ sp config list [--json]
|
|
258
260
|
|
|
259
261
|
GLOBAL FLAGS
|
|
260
|
-
--
|
|
261
|
-
--json Format output as json.
|
|
262
|
-
--url=<value> Specify provider base URL.
|
|
262
|
+
--json Format output as json.
|
|
263
263
|
|
|
264
264
|
DESCRIPTION
|
|
265
265
|
List all configurations
|
|
@@ -268,7 +268,7 @@ EXAMPLES
|
|
|
268
268
|
$ sp config list
|
|
269
269
|
```
|
|
270
270
|
|
|
271
|
-
_See code: [src/commands/config/list.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-
|
|
271
|
+
_See code: [src/commands/config/list.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/config/list.ts)_
|
|
272
272
|
|
|
273
273
|
## `sp config show`
|
|
274
274
|
|
|
@@ -276,12 +276,10 @@ Show current configuration
|
|
|
276
276
|
|
|
277
277
|
```
|
|
278
278
|
USAGE
|
|
279
|
-
$ sp config show [--json]
|
|
279
|
+
$ sp config show [--json]
|
|
280
280
|
|
|
281
281
|
GLOBAL FLAGS
|
|
282
|
-
--
|
|
283
|
-
--json Format output as json.
|
|
284
|
-
--url=<value> Specify provider base URL.
|
|
282
|
+
--json Format output as json.
|
|
285
283
|
|
|
286
284
|
DESCRIPTION
|
|
287
285
|
Show current configuration
|
|
@@ -290,7 +288,7 @@ EXAMPLES
|
|
|
290
288
|
$ sp config show
|
|
291
289
|
```
|
|
292
290
|
|
|
293
|
-
_See code: [src/commands/config/show.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-
|
|
291
|
+
_See code: [src/commands/config/show.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/config/show.ts)_
|
|
294
292
|
|
|
295
293
|
## `sp config use`
|
|
296
294
|
|
|
@@ -298,12 +296,10 @@ Switch to a different configuration file
|
|
|
298
296
|
|
|
299
297
|
```
|
|
300
298
|
USAGE
|
|
301
|
-
$ sp config use [--json]
|
|
299
|
+
$ sp config use [--json]
|
|
302
300
|
|
|
303
301
|
GLOBAL FLAGS
|
|
304
|
-
--
|
|
305
|
-
--json Format output as json.
|
|
306
|
-
--url=<value> Specify provider base URL.
|
|
302
|
+
--json Format output as json.
|
|
307
303
|
|
|
308
304
|
DESCRIPTION
|
|
309
305
|
Switch to a different configuration file
|
|
@@ -312,315 +308,204 @@ EXAMPLES
|
|
|
312
308
|
$ sp config use
|
|
313
309
|
```
|
|
314
310
|
|
|
315
|
-
_See code: [src/commands/config/use.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-
|
|
311
|
+
_See code: [src/commands/config/use.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/config/use.ts)_
|
|
316
312
|
|
|
317
|
-
## `sp
|
|
313
|
+
## `sp files download RESOURCEFILE LOCALDIRECTORY`
|
|
318
314
|
|
|
319
|
-
|
|
315
|
+
describe the command here
|
|
320
316
|
|
|
321
317
|
```
|
|
322
318
|
USAGE
|
|
323
|
-
$ sp
|
|
319
|
+
$ sp files download RESOURCEFILE LOCALDIRECTORY [--json] [--config <value>] [--maximum-concurrent <value>]
|
|
324
320
|
|
|
325
321
|
ARGUMENTS
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
FLAGS
|
|
329
|
-
-n, --nested-commands Include all nested commands in the output.
|
|
330
|
-
|
|
331
|
-
DESCRIPTION
|
|
332
|
-
Display help for sp.
|
|
333
|
-
```
|
|
334
|
-
|
|
335
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.33/src/commands/help.ts)_
|
|
336
|
-
|
|
337
|
-
## `sp plugins`
|
|
338
|
-
|
|
339
|
-
List installed plugins.
|
|
340
|
-
|
|
341
|
-
```
|
|
342
|
-
USAGE
|
|
343
|
-
$ sp plugins [--json] [--core]
|
|
322
|
+
RESOURCEFILE Path to a resource file
|
|
323
|
+
LOCALDIRECTORY Path to save downloaded file
|
|
344
324
|
|
|
345
325
|
FLAGS
|
|
346
|
-
--
|
|
326
|
+
--maximum-concurrent=<value> [default: 1] Maximum concurrent pieces to upload at once per transfer
|
|
347
327
|
|
|
348
328
|
GLOBAL FLAGS
|
|
349
|
-
--
|
|
329
|
+
--config=<value> Specify config file.
|
|
330
|
+
--json Format output as json.
|
|
350
331
|
|
|
351
332
|
DESCRIPTION
|
|
352
|
-
|
|
333
|
+
describe the command here
|
|
353
334
|
|
|
354
335
|
EXAMPLES
|
|
355
|
-
$ sp
|
|
336
|
+
$ sp files download ./resource.json ./pathToDownload
|
|
356
337
|
```
|
|
357
338
|
|
|
358
|
-
_See code: [
|
|
339
|
+
_See code: [src/commands/files/download.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/files/download.ts)_
|
|
359
340
|
|
|
360
|
-
## `sp
|
|
341
|
+
## `sp files upload PATH`
|
|
361
342
|
|
|
362
|
-
|
|
343
|
+
describe the command here
|
|
363
344
|
|
|
364
345
|
```
|
|
365
346
|
USAGE
|
|
366
|
-
$ sp
|
|
347
|
+
$ sp files upload PATH [--json] [--config <value>] [--filename <value>] [--maximum-concurrent <value>]
|
|
348
|
+
[--metadata <value>] [--output <value>] [--skip-encryption] [--sync]
|
|
367
349
|
|
|
368
350
|
ARGUMENTS
|
|
369
|
-
|
|
351
|
+
PATH file or directory to upload
|
|
370
352
|
|
|
371
353
|
FLAGS
|
|
372
|
-
|
|
373
|
-
-
|
|
374
|
-
|
|
375
|
-
|
|
354
|
+
--filename=<value> The name of the resulting file/directory in the storage
|
|
355
|
+
--maximum-concurrent=<value> [default: 1] Maximum concurrent pieces to upload at once per transfer
|
|
356
|
+
--metadata=<value> Path to a metadata file for adding fields to the resource file
|
|
357
|
+
--output=<value> [default: resource.json] Path to save resource file that is used to access the uploaded
|
|
358
|
+
file
|
|
359
|
+
--skip-encryption Skip file encryption before upload
|
|
360
|
+
--sync Sync mode: delete files in target that don't exist in source
|
|
376
361
|
|
|
377
362
|
GLOBAL FLAGS
|
|
378
|
-
--
|
|
363
|
+
--config=<value> Specify config file.
|
|
364
|
+
--json Format output as json.
|
|
379
365
|
|
|
380
366
|
DESCRIPTION
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
Uses npm to install plugins.
|
|
384
|
-
|
|
385
|
-
Installation of a user-installed plugin will override a core plugin.
|
|
386
|
-
|
|
387
|
-
Use the SP_NPM_LOG_LEVEL environment variable to set the npm loglevel.
|
|
388
|
-
Use the SP_NPM_REGISTRY environment variable to set the npm registry.
|
|
389
|
-
|
|
390
|
-
ALIASES
|
|
391
|
-
$ sp plugins add
|
|
367
|
+
describe the command here
|
|
392
368
|
|
|
393
369
|
EXAMPLES
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
$ sp plugins add myplugin
|
|
397
|
-
|
|
398
|
-
Install a plugin from a github url.
|
|
399
|
-
|
|
400
|
-
$ sp plugins add https://github.com/someuser/someplugin
|
|
401
|
-
|
|
402
|
-
Install a plugin from a github slug.
|
|
403
|
-
|
|
404
|
-
$ sp plugins add someuser/someplugin
|
|
370
|
+
$ sp files upload ./file.txt
|
|
405
371
|
```
|
|
406
372
|
|
|
407
|
-
|
|
373
|
+
_See code: [src/commands/files/upload.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/files/upload.ts)_
|
|
408
374
|
|
|
409
|
-
|
|
375
|
+
## `sp help [COMMAND]`
|
|
376
|
+
|
|
377
|
+
Display help for sp.
|
|
410
378
|
|
|
411
379
|
```
|
|
412
380
|
USAGE
|
|
413
|
-
$ sp
|
|
381
|
+
$ sp help [COMMAND...] [-n]
|
|
414
382
|
|
|
415
383
|
ARGUMENTS
|
|
416
|
-
|
|
384
|
+
[COMMAND...] Command to show help for.
|
|
417
385
|
|
|
418
386
|
FLAGS
|
|
419
|
-
-
|
|
420
|
-
-v, --verbose
|
|
421
|
-
|
|
422
|
-
GLOBAL FLAGS
|
|
423
|
-
--json Format output as json.
|
|
387
|
+
-n, --nested-commands Include all nested commands in the output.
|
|
424
388
|
|
|
425
389
|
DESCRIPTION
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
EXAMPLES
|
|
429
|
-
$ sp plugins inspect myplugin
|
|
390
|
+
Display help for sp.
|
|
430
391
|
```
|
|
431
392
|
|
|
432
|
-
_See code: [@oclif/plugin-
|
|
393
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.33/src/commands/help.ts)_
|
|
433
394
|
|
|
434
|
-
## `sp
|
|
395
|
+
## `sp login`
|
|
435
396
|
|
|
436
|
-
|
|
397
|
+
Authorization
|
|
437
398
|
|
|
438
399
|
```
|
|
439
400
|
USAGE
|
|
440
|
-
$ sp
|
|
441
|
-
|
|
442
|
-
ARGUMENTS
|
|
443
|
-
PLUGIN... Plugin to install.
|
|
444
|
-
|
|
445
|
-
FLAGS
|
|
446
|
-
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
|
|
447
|
-
-h, --help Show CLI help.
|
|
448
|
-
-s, --silent Silences npm output.
|
|
449
|
-
-v, --verbose Show verbose npm output.
|
|
401
|
+
$ sp login [--json] [--config <value>]
|
|
450
402
|
|
|
451
403
|
GLOBAL FLAGS
|
|
452
|
-
--
|
|
404
|
+
--config=<value> Specify config file.
|
|
405
|
+
--json Format output as json.
|
|
453
406
|
|
|
454
407
|
DESCRIPTION
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
Uses npm to install plugins.
|
|
458
|
-
|
|
459
|
-
Installation of a user-installed plugin will override a core plugin.
|
|
460
|
-
|
|
461
|
-
Use the SP_NPM_LOG_LEVEL environment variable to set the npm loglevel.
|
|
462
|
-
Use the SP_NPM_REGISTRY environment variable to set the npm registry.
|
|
408
|
+
Authorization
|
|
463
409
|
|
|
464
410
|
ALIASES
|
|
465
|
-
$ sp
|
|
411
|
+
$ sp login
|
|
466
412
|
|
|
467
413
|
EXAMPLES
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
$ sp plugins install myplugin
|
|
471
|
-
|
|
472
|
-
Install a plugin from a github url.
|
|
473
|
-
|
|
474
|
-
$ sp plugins install https://github.com/someuser/someplugin
|
|
475
|
-
|
|
476
|
-
Install a plugin from a github slug.
|
|
477
|
-
|
|
478
|
-
$ sp plugins install someuser/someplugin
|
|
414
|
+
$ sp login
|
|
479
415
|
```
|
|
480
416
|
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
## `sp plugins link PATH`
|
|
484
|
-
|
|
485
|
-
Links a plugin into the CLI for development.
|
|
417
|
+
## `sp storage base`
|
|
486
418
|
|
|
487
419
|
```
|
|
488
420
|
USAGE
|
|
489
|
-
$ sp
|
|
490
|
-
|
|
491
|
-
ARGUMENTS
|
|
492
|
-
PATH [default: .] path to plugin
|
|
493
|
-
|
|
494
|
-
FLAGS
|
|
495
|
-
-h, --help Show CLI help.
|
|
496
|
-
-v, --verbose
|
|
497
|
-
--[no-]install Install dependencies after linking the plugin.
|
|
498
|
-
|
|
499
|
-
DESCRIPTION
|
|
500
|
-
Links a plugin into the CLI for development.
|
|
421
|
+
$ sp storage base [--json] [--config <value>]
|
|
501
422
|
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
command will override the user-installed or core plugin implementation. This is useful for development work.
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
EXAMPLES
|
|
509
|
-
$ sp plugins link myplugin
|
|
423
|
+
GLOBAL FLAGS
|
|
424
|
+
--config=<value> Specify config file.
|
|
425
|
+
--json Format output as json.
|
|
510
426
|
```
|
|
511
427
|
|
|
512
|
-
_See code: [
|
|
428
|
+
_See code: [src/commands/storage/base.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/storage/base.ts)_
|
|
513
429
|
|
|
514
|
-
## `sp
|
|
430
|
+
## `sp storage create`
|
|
515
431
|
|
|
516
|
-
|
|
432
|
+
Create a new storage entry from file or interactive prompts.
|
|
517
433
|
|
|
518
434
|
```
|
|
519
435
|
USAGE
|
|
520
|
-
$ sp
|
|
521
|
-
|
|
522
|
-
ARGUMENTS
|
|
523
|
-
[PLUGIN...] plugin to uninstall
|
|
436
|
+
$ sp storage create [--json] [--config <value>] [-f <value>] [--notDefault]
|
|
524
437
|
|
|
525
438
|
FLAGS
|
|
526
|
-
-
|
|
527
|
-
|
|
439
|
+
-f, --fromFile=<value> Path to a JSON file that contains AddStorageDto payload.
|
|
440
|
+
--notDefault Skip setting the created storage as default.
|
|
528
441
|
|
|
529
|
-
|
|
530
|
-
|
|
442
|
+
GLOBAL FLAGS
|
|
443
|
+
--config=<value> Specify config file.
|
|
444
|
+
--json Format output as json.
|
|
531
445
|
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
$ sp plugins remove
|
|
446
|
+
DESCRIPTION
|
|
447
|
+
Create a new storage entry from file or interactive prompts.
|
|
535
448
|
|
|
536
449
|
EXAMPLES
|
|
537
|
-
$ sp
|
|
538
|
-
```
|
|
539
|
-
|
|
540
|
-
## `sp plugins reset`
|
|
450
|
+
$ sp storage create
|
|
541
451
|
|
|
542
|
-
|
|
452
|
+
$ sp storage create --fromFile ./storage.json
|
|
543
453
|
|
|
454
|
+
$ sp storage create --not-default
|
|
544
455
|
```
|
|
545
|
-
USAGE
|
|
546
|
-
$ sp plugins reset [--hard] [--reinstall]
|
|
547
456
|
|
|
548
|
-
|
|
549
|
-
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
|
|
550
|
-
--reinstall Reinstall all plugins after uninstalling.
|
|
551
|
-
```
|
|
552
|
-
|
|
553
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.50/src/commands/plugins/reset.ts)_
|
|
457
|
+
_See code: [src/commands/storage/create.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/storage/create.ts)_
|
|
554
458
|
|
|
555
|
-
## `sp
|
|
459
|
+
## `sp storage select`
|
|
556
460
|
|
|
557
|
-
|
|
461
|
+
Select a storage that will be used by subsequent commands.
|
|
558
462
|
|
|
559
463
|
```
|
|
560
464
|
USAGE
|
|
561
|
-
$ sp
|
|
562
|
-
|
|
563
|
-
ARGUMENTS
|
|
564
|
-
[PLUGIN...] plugin to uninstall
|
|
465
|
+
$ sp storage select [--json] [--config <value>] [-i <value>]
|
|
565
466
|
|
|
566
467
|
FLAGS
|
|
567
|
-
-
|
|
568
|
-
-v, --verbose
|
|
468
|
+
-i, --id=<value> Storage ID to select
|
|
569
469
|
|
|
570
|
-
|
|
571
|
-
|
|
470
|
+
GLOBAL FLAGS
|
|
471
|
+
--config=<value> Specify config file.
|
|
472
|
+
--json Format output as json.
|
|
572
473
|
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
$ sp plugins remove
|
|
474
|
+
DESCRIPTION
|
|
475
|
+
Select a storage that will be used by subsequent commands.
|
|
576
476
|
|
|
577
477
|
EXAMPLES
|
|
578
|
-
$ sp
|
|
478
|
+
$ sp storage select
|
|
479
|
+
|
|
480
|
+
$ sp storage select --id=2de3e3a4-0000-1111-2222-333344445555
|
|
579
481
|
```
|
|
580
482
|
|
|
581
|
-
_See code: [
|
|
483
|
+
_See code: [src/commands/storage/select.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/storage/select.ts)_
|
|
582
484
|
|
|
583
|
-
## `sp
|
|
485
|
+
## `sp storage update`
|
|
584
486
|
|
|
585
|
-
|
|
487
|
+
Update the configuration of an existing storage.
|
|
586
488
|
|
|
587
489
|
```
|
|
588
490
|
USAGE
|
|
589
|
-
$ sp
|
|
590
|
-
|
|
591
|
-
ARGUMENTS
|
|
592
|
-
[PLUGIN...] plugin to uninstall
|
|
491
|
+
$ sp storage update [--json] [--config <value>] [-f <value>] [-i <value>]
|
|
593
492
|
|
|
594
493
|
FLAGS
|
|
595
|
-
-
|
|
596
|
-
-
|
|
494
|
+
-f, --fromFile=<value> Path to a JSON file that contains UpdateStorageDto payload.
|
|
495
|
+
-i, --id=<value> Storage ID to update
|
|
597
496
|
|
|
598
|
-
|
|
599
|
-
|
|
497
|
+
GLOBAL FLAGS
|
|
498
|
+
--config=<value> Specify config file.
|
|
499
|
+
--json Format output as json.
|
|
600
500
|
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
$ sp plugins remove
|
|
501
|
+
DESCRIPTION
|
|
502
|
+
Update the configuration of an existing storage.
|
|
604
503
|
|
|
605
504
|
EXAMPLES
|
|
606
|
-
$ sp
|
|
607
|
-
```
|
|
608
|
-
|
|
609
|
-
## `sp plugins update`
|
|
610
|
-
|
|
611
|
-
Update installed plugins.
|
|
505
|
+
$ sp storage update --id=2de3e3a4-0000-1111-2222-333344445555 --fromFile ./storage-update.json
|
|
612
506
|
|
|
613
|
-
|
|
614
|
-
USAGE
|
|
615
|
-
$ sp plugins update [-h] [-v]
|
|
616
|
-
|
|
617
|
-
FLAGS
|
|
618
|
-
-h, --help Show CLI help.
|
|
619
|
-
-v, --verbose
|
|
620
|
-
|
|
621
|
-
DESCRIPTION
|
|
622
|
-
Update installed plugins.
|
|
507
|
+
$ sp storage update --id=2de3e3a4-0000-1111-2222-333344445555
|
|
623
508
|
```
|
|
624
509
|
|
|
625
|
-
_See code: [
|
|
510
|
+
_See code: [src/commands/storage/update.ts](https://github.com/Super-Protocol/sp-cli/blob/v0.0.2-beta.10/src/commands/storage/update.ts)_
|
|
626
511
|
<!-- commandsstop -->
|