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