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