Skip to content

Commit

Permalink
Merge pull request #204 from thepower/fix/clI_container_upload_fix
Browse files Browse the repository at this point in the history
oclif readme
  • Loading branch information
jackkru69 authored Dec 18, 2024
2 parents 6f5c67e + 8335f5c commit ce01c2d
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 26 deletions.
2 changes: 1 addition & 1 deletion .changeset/pre.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"mode": "pre",
"mode": "exit",
"tag": "canary",
"initialVersions": {
"@thepowereco/cli": "1.12.15",
Expand Down
5 changes: 5 additions & 0 deletions .changeset/smooth-buses-repair.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@thepowereco/cli': patch
---

oclif readme
61 changes: 36 additions & 25 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ $ npm install -g @thepowereco/cli
$ tpe COMMAND
running command...
$ tpe (--version)
@thepowereco/cli/1.12.15-canary.4 linux-x64 node-v23.1.0
@thepowereco/cli/1.12.15 linux-x64 node-v23.3.0
$ tpe --help [COMMAND]
USAGE
$ tpe COMMAND
Expand Down Expand Up @@ -94,7 +94,7 @@ EXAMPLES
$ tpe acc get-balance --keyFilePath ./path/to/keyfile.pem --password mypassword
```

_See code: [dist/esm/src/commands/acc/get-balance.js](https://github.com/thepower/PowerTools/blob/v1.12.15-canary.4/dist/esm/src/commands/acc/get-balance.js)_
_See code: [dist/esm/src/commands/acc/get-balance.js](https://github.com/thepower/PowerTools/blob/v1.12.15/dist/esm/src/commands/acc/get-balance.js)_

## `tpe acc register`

Expand Down Expand Up @@ -135,7 +135,7 @@ EXAMPLES
Register a new account on a specified chain without saving the data to a file.
```

_See code: [dist/esm/src/commands/acc/register.js](https://github.com/thepower/PowerTools/blob/v1.12.15-canary.4/dist/esm/src/commands/acc/register.js)_
_See code: [dist/esm/src/commands/acc/register.js](https://github.com/thepower/PowerTools/blob/v1.12.15/dist/esm/src/commands/acc/register.js)_

## `tpe acc send-sk`

Expand Down Expand Up @@ -171,7 +171,7 @@ EXAMPLES
$ tpe acc send-sk --amount 100 --to AA100000001677748249 --keyFilePath ./path/to/keyfile.pem
```

_See code: [dist/esm/src/commands/acc/send-sk.js](https://github.com/thepower/PowerTools/blob/v1.12.15-canary.4/dist/esm/src/commands/acc/send-sk.js)_
_See code: [dist/esm/src/commands/acc/send-sk.js](https://github.com/thepower/PowerTools/blob/v1.12.15/dist/esm/src/commands/acc/send-sk.js)_

## `tpe autocomplete [SHELL]`

Expand Down Expand Up @@ -227,20 +227,20 @@ DESCRIPTION
Perform various container actions
EXAMPLES
$ tpe container actions -m "container_start" -p 1 -f ./path/to/keyfile.pem -s mypassword
$ tpe container actions -m "container_start" -i 1 -p 1 -f ./path/to/keyfile.pem -s mypassword
$ tpe container actions -m "container_stop" -p 1 -f ./path/to/keyfile.pem -s mypassword
$ tpe container actions -m "container_stop" -i 1 -p 1 -f ./path/to/keyfile.pem -s mypassword
$ tpe container actions -m "container_destroy" -p 1 -f ./path/to/keyfile.pem -s mypassword
$ tpe container actions -m "container_destroy" -i 1 -p 1 -f ./path/to/keyfile.pem -s mypassword
$ tpe container actions -m "container_handover" -p 1 -f ./path/to/keyfile.pem -s mypassword
$ tpe container actions -m "container_handover" -i 1 -p 1 -f ./path/to/keyfile.pem -s mypassword
$ tpe container actions -m "container_getPort" -p "1 web 5000" -f ./path/to/keyfile.pem -s mypassword
$ tpe container actions -m "container_getPort" -i 1 -p "1 web 5000" -f ./path/to/keyfile.pem -s mypassword
$ tpe container actions -m "container_getLogs" -p 1 -f ./path/to/keyfile.pem -s mypassword
$ tpe container actions -m "container_getLogs" -i 1 -p 1 -f ./path/to/keyfile.pem -s mypassword
```

_See code: [dist/esm/src/commands/container/actions.js](https://github.com/thepower/PowerTools/blob/v1.12.15-canary.4/dist/esm/src/commands/container/actions.js)_
_See code: [dist/esm/src/commands/container/actions.js](https://github.com/thepower/PowerTools/blob/v1.12.15/dist/esm/src/commands/container/actions.js)_

## `tpe container create`

Expand Down Expand Up @@ -271,7 +271,7 @@ EXAMPLES
$ tpe container create -k ./key.pem --password mypassword --containerName "NewContainer" --containerPassword containerpassword
```

_See code: [dist/esm/src/commands/container/create.js](https://github.com/thepower/PowerTools/blob/v1.12.15-canary.4/dist/esm/src/commands/container/create.js)_
_See code: [dist/esm/src/commands/container/create.js](https://github.com/thepower/PowerTools/blob/v1.12.15/dist/esm/src/commands/container/create.js)_

## `tpe container list`

Expand All @@ -297,7 +297,7 @@ EXAMPLES
$ tpe container list -k ./key.pem --password mypassword
```

_See code: [dist/esm/src/commands/container/list.js](https://github.com/thepower/PowerTools/blob/v1.12.15-canary.4/dist/esm/src/commands/container/list.js)_
_See code: [dist/esm/src/commands/container/list.js](https://github.com/thepower/PowerTools/blob/v1.12.15/dist/esm/src/commands/container/list.js)_

## `tpe container update`

Expand Down Expand Up @@ -329,7 +329,7 @@ EXAMPLES
--containerName "New Container Name" --containerKeyFilePath ./containerKey.pem --containerPassword containerpassword
```

_See code: [dist/esm/src/commands/container/update.js](https://github.com/thepower/PowerTools/blob/v1.12.15-canary.4/dist/esm/src/commands/container/update.js)_
_See code: [dist/esm/src/commands/container/update.js](https://github.com/thepower/PowerTools/blob/v1.12.15/dist/esm/src/commands/container/update.js)_

## `tpe container upload`

Expand All @@ -338,14 +338,15 @@ Upload files to a container
```
USAGE
$ tpe container upload -k <value> -i <value> -f <value> -t <value> [-p <value>] [-s <value>] [-c] [-a <value>] [-b
<value>] [-n <value>] [-e]
<value>] [-n <value>] [-g <value>] [-e]
FLAGS
-a, --ordersScAddress=<value> [default: AA100000005033174401] Orders smart contract address
-b, --providerScAddress=<value> [default: AA100000005033174348] Provider smart contract address
-c, --chooseProvider Choose provider
-e, --isEth Use an ethereum address
-f, --containerKeyFilePath=<value> (required) Path to the container key file
-g, --ignoreUploadList=<value> Ignore upload list (e.g. "[.git,node_modules,logs]")
-i, --containerId=<value> (required) Container ID
-k, --keyFilePath=<value> (required) Path to the key file
-n, --chain=<value> Chain ID
Expand All @@ -359,10 +360,20 @@ DESCRIPTION
EXAMPLES
$ tpe container upload --containerId 123 --containerKeyFilePath ./key.pem --containerPassword mypassword --filesPath ./files
$ tpe container upload -i 123 -f ./key.pem -s mypassword -p ./files
$ tpe container upload -i 123 -f ./key.pem -s mypassword -t ./files
$ tpe container upload --containerId 123 --containerKeyFilePath ./key.pem --containerPassword mypassword --filesPath ./files --chooseProvider
$ tpe container upload -i 123 -f ./key.pem -s mypassword -t ./files --ignoreUploadList "[.git,node_modules,logs]"
$ tpe container upload --containerId 456 --containerKeyFilePath ./key.pem --containerPassword ethpassword --filesPath ./upload --isEth
$ tpe container upload -i 789 -f ./container-key.pem -s "securepassword" -t ./files --ordersScAddress 0xOrder123 --providerScAddress 0xProvider456
$ tpe container upload --containerId 321 --containerKeyFilePath ./key.pem --containerPassword mypassword --filesPath ./data --chain 5
```

_See code: [dist/esm/src/commands/container/upload.js](https://github.com/thepower/PowerTools/blob/v1.12.15-canary.4/dist/esm/src/commands/container/upload.js)_
_See code: [dist/esm/src/commands/container/upload.js](https://github.com/thepower/PowerTools/blob/v1.12.15/dist/esm/src/commands/container/upload.js)_

## `tpe contract deploy`

Expand Down Expand Up @@ -396,7 +407,7 @@ EXAMPLES
$ tpe contract deploy --abiPath ./path/to/abi.json --binPath ./path/to/bin --keyFilePath ./path/to/keyfile.pem --initParams "param1 param2"
```

_See code: [dist/esm/src/commands/contract/deploy.js](https://github.com/thepower/PowerTools/blob/v1.12.15-canary.4/dist/esm/src/commands/contract/deploy.js)_
_See code: [dist/esm/src/commands/contract/deploy.js](https://github.com/thepower/PowerTools/blob/v1.12.15/dist/esm/src/commands/contract/deploy.js)_

## `tpe contract get`

Expand All @@ -423,7 +434,7 @@ EXAMPLES
$ tpe contract get --abiPath ./path/to/abi.json --address AA100000001677748249 --method getInfo
```

_See code: [dist/esm/src/commands/contract/get.js](https://github.com/thepower/PowerTools/blob/v1.12.15-canary.4/dist/esm/src/commands/contract/get.js)_
_See code: [dist/esm/src/commands/contract/get.js](https://github.com/thepower/PowerTools/blob/v1.12.15/dist/esm/src/commands/contract/get.js)_

## `tpe contract set`

Expand Down Expand Up @@ -459,7 +470,7 @@ EXAMPLES
--address AA100000001677748249 --keyFilePath ./path/to/keyfile.pem --method setData --params "0x456 1 2 [1,2] {a: 1, b: 2} 1n"
```

_See code: [dist/esm/src/commands/contract/set.js](https://github.com/thepower/PowerTools/blob/v1.12.15-canary.4/dist/esm/src/commands/contract/set.js)_
_See code: [dist/esm/src/commands/contract/set.js](https://github.com/thepower/PowerTools/blob/v1.12.15/dist/esm/src/commands/contract/set.js)_

## `tpe help [COMMAND]`

Expand Down Expand Up @@ -797,7 +808,7 @@ EXAMPLES
$ tpe provider create -k ./key.pem --password mypassword --containerName "NewProvider" --containerPassword containerpassword
```

_See code: [dist/esm/src/commands/provider/create.js](https://github.com/thepower/PowerTools/blob/v1.12.15-canary.4/dist/esm/src/commands/provider/create.js)_
_See code: [dist/esm/src/commands/provider/create.js](https://github.com/thepower/PowerTools/blob/v1.12.15/dist/esm/src/commands/provider/create.js)_

## `tpe provider list`

Expand Down Expand Up @@ -825,7 +836,7 @@ EXAMPLES
$ tpe provider list --address 0x123...abc
```

_See code: [dist/esm/src/commands/provider/list.js](https://github.com/thepower/PowerTools/blob/v1.12.15-canary.4/dist/esm/src/commands/provider/list.js)_
_See code: [dist/esm/src/commands/provider/list.js](https://github.com/thepower/PowerTools/blob/v1.12.15/dist/esm/src/commands/provider/list.js)_

## `tpe provider set-url`

Expand Down Expand Up @@ -856,7 +867,7 @@ EXAMPLES
$ tpe provider set-url -k ./key.pem -i 123 -u "https://provider.example.com" --sponsorAddress 0xSponsorAddress
```

_See code: [dist/esm/src/commands/provider/set-url.js](https://github.com/thepower/PowerTools/blob/v1.12.15-canary.4/dist/esm/src/commands/provider/set-url.js)_
_See code: [dist/esm/src/commands/provider/set-url.js](https://github.com/thepower/PowerTools/blob/v1.12.15/dist/esm/src/commands/provider/set-url.js)_

## `tpe storage tasklist`

Expand All @@ -881,7 +892,7 @@ EXAMPLES
$ tpe storage tasklist ./tp-cli.json
```

_See code: [dist/esm/src/commands/storage/tasklist.js](https://github.com/thepower/PowerTools/blob/v1.12.15-canary.4/dist/esm/src/commands/storage/tasklist.js)_
_See code: [dist/esm/src/commands/storage/tasklist.js](https://github.com/thepower/PowerTools/blob/v1.12.15/dist/esm/src/commands/storage/tasklist.js)_

## `tpe storage upload`

Expand All @@ -907,7 +918,7 @@ EXAMPLES
$ tpe storage upload ./tp-cli.json
```

_See code: [dist/esm/src/commands/storage/upload.js](https://github.com/thepower/PowerTools/blob/v1.12.15-canary.4/dist/esm/src/commands/storage/upload.js)_
_See code: [dist/esm/src/commands/storage/upload.js](https://github.com/thepower/PowerTools/blob/v1.12.15/dist/esm/src/commands/storage/upload.js)_

## `tpe update [CHANNEL]`

Expand Down

0 comments on commit ce01c2d

Please sign in to comment.