@proton/cli

@proton/cli

Proton CLI

• Installation
• Usage
• Commands

Installation

Install NodeJS + NPM + CLI

curl -Ls https://raw.githubusercontent.com/ProtonProtocol/proton-cli/master/install.sh | sh

Install CLI (NPM)

npm i -g @proton/cli

Install CLI (Yarn)

yarn global add @proton/cli

Usage

$ npm install -g @proton/cli
$ proton COMMAND
running command...
$ proton (--version)
@proton/cli/0.1.20 darwin-arm64 node-v17.6.0
$ proton --help [COMMAND]
USAGE
  $ proton COMMAND
...

Commands

• proton account ACCOUNTNAME
• proton account:create ACCOUNTNAME
• proton action CONTRACTNAME [ACTIONNAME] [DATA] [AUTHORIZATION]
• proton block:get BLOCKNUMBER
• proton boilerplate [FOLDER]
• proton chain:get
• proton chain:info
• proton chain:list
• proton chain:set
• proton contract:abi ACCOUNTNAME
• proton contract:deploy ACCOUNT DIRECTORY
• proton help [COMMAND]
• proton keys:add [PRIVATEKEY]
• proton keys:generate
• proton keys:get PUBLICKEY
• proton keys:list
• proton keys:lock
• proton keys:remove [PRIVATEKEY]
• proton keys:reset
• proton keys:unlock [PASSWORD]
• proton multisig:contract DIRECTORY
• proton network
• proton table CONTRACTNAME [TABLENAME] [SCOPE]
• proton transaction JSON
• proton transaction:get TRANSACTIONID
• proton version

proton account ACCOUNTNAME

Get Account Information

USAGE
  $ proton account [ACCOUNTNAME] [-r]

FLAGS
  -r, --raw

DESCRIPTION
  Get Account Information

See code: src/commands/account/index.ts

proton account:create ACCOUNTNAME

Create New Account

USAGE
  $ proton account:create [ACCOUNTNAME]

DESCRIPTION
  Create New Account

See code: src/commands/account/create.ts

proton action CONTRACTNAME [ACTIONNAME] [DATA] [AUTHORIZATION]

Execute Action

USAGE
  $ proton action [CONTRACTNAME] [ACTIONNAME] [DATA] [AUTHORIZATION]

ARGUMENTS
  CONTRACTNAME
  ACTIONNAME
  DATA
  AUTHORIZATION  Account to authorize with

DESCRIPTION
  Execute Action

See code: src/commands/action/index.ts

proton block:get BLOCKNUMBER

Get Block

USAGE
  $ proton block:get [BLOCKNUMBER]

DESCRIPTION
  Get Block

See code: src/commands/block/get.ts

proton boilerplate [FOLDER]

Boilerplate a new Proton Project with contract, frontend and tests

USAGE
  $ proton boilerplate [FOLDER] [-h]

FLAGS
  -h, --help  show CLI help

DESCRIPTION
  Boilerplate a new Proton Project with contract, frontend and tests

See code: src/commands/boilerplate.ts

proton chain:get

Get Current Chain

USAGE
  $ proton chain:get

DESCRIPTION
  Get Current Chain

ALIASES
  $ proton network

See code: src/commands/chain/get.ts

proton chain:info

Get Chain Info

USAGE
  $ proton chain:info

DESCRIPTION
  Get Chain Info

See code: src/commands/chain/info.ts

proton chain:list

All Networks

USAGE
  $ proton chain:list

DESCRIPTION
  All Networks

See code: src/commands/chain/list.ts

proton chain:set

Set Chain

USAGE
  $ proton chain:set [--chain proton|proton-test]

FLAGS
  --chain=<option>  <options: proton|proton-test>

DESCRIPTION
  Set Chain

See code: src/commands/chain/set.ts

proton contract:abi ACCOUNTNAME

Get Contract ABI

USAGE
  $ proton contract:abi [ACCOUNTNAME]

DESCRIPTION
  Get Contract ABI

See code: src/commands/contract/abi.ts

proton contract:deploy ACCOUNT DIRECTORY

Deploy Contract

USAGE
  $ proton contract:deploy [ACCOUNT] [DIRECTORY] [-c] [-a] [-w]

FLAGS
  -a, --abiOnly   Only deploy ABI
  -c, --clear     Removes WASM + ABI from contract
  -w, --wasmOnly  Only deploy WASM

DESCRIPTION
  Deploy Contract

See code: src/commands/contract/deploy.ts

proton help [COMMAND]

display help for proton

USAGE
  $ proton help [COMMAND] [--all]

ARGUMENTS
  COMMAND  command to show help for

FLAGS
  --all  see all commands in CLI

DESCRIPTION
  display help for proton

See code: @oclif/plugin-help

proton keys:add [PRIVATEKEY]

Add Key

USAGE
  $ proton keys:add [PRIVATEKEY]

DESCRIPTION
  Add Key

See code: src/commands/keys/add.ts

proton keys:generate

Generate Key

USAGE
  $ proton keys:generate

DESCRIPTION
  Generate Key

See code: src/commands/keys/generate.ts

proton keys:get PUBLICKEY

Find private key for public key

USAGE
  $ proton keys:get [PUBLICKEY]

DESCRIPTION
  Find private key for public key

See code: src/commands/keys/get.ts

proton keys:list

List All Key

USAGE
  $ proton keys:list

DESCRIPTION
  List All Key

See code: src/commands/keys/list.ts

proton keys:lock

Lock Keys with password

USAGE
  $ proton keys:lock

DESCRIPTION
  Lock Keys with password

See code: src/commands/keys/lock.ts

proton keys:remove [PRIVATEKEY]

Remove Key

USAGE
  $ proton keys:remove [PRIVATEKEY]

DESCRIPTION
  Remove Key

See code: src/commands/keys/remove.ts

proton keys:reset

Reset password (Caution: deletes all private keys stored)

USAGE
  $ proton keys:reset

DESCRIPTION
  Reset password (Caution: deletes all private keys stored)

See code: src/commands/keys/reset.ts

proton keys:unlock [PASSWORD]

Unlock all keys (Caution: Your keys will be stored in plaintext on disk)

USAGE
  $ proton keys:unlock [PASSWORD]

DESCRIPTION
  Unlock all keys (Caution: Your keys will be stored in plaintext on disk)

See code: src/commands/keys/unlock.ts

proton multisig:contract DIRECTORY

Multisig Contract

USAGE
  $ proton multisig:contract [DIRECTORY]

DESCRIPTION
  Multisig Contract

See code: src/commands/multisig/contract.ts

proton network

Get Current Chain

USAGE
  $ proton network

DESCRIPTION
  Get Current Chain

ALIASES
  $ proton network

proton table CONTRACTNAME [TABLENAME] [SCOPE]

Get Table Storage Rows

USAGE
  $ proton table [CONTRACTNAME] [TABLENAME] [SCOPE] [-l <value>] [-u <value>] [-k <value>] [-r] [-p] [-c
    <value>] [-i <value>]

FLAGS
  -c, --limit=<value>          [default: 100]
  -i, --indexPosition=<value>  [default: 1]
  -k, --keyType=<value>
  -l, --lowerBound=<value>
  -p, --showPayer
  -r, --reverse
  -u, --upperBound=<value>

DESCRIPTION
  Get Table Storage Rows

See code: src/commands/table/index.ts

proton transaction JSON

Execute Transaction

USAGE
  $ proton transaction [JSON]

DESCRIPTION
  Execute Transaction

See code: src/commands/transaction/index.ts

proton transaction:get TRANSACTIONID

Get Transaction by Transaction ID

USAGE
  $ proton transaction:get [TRANSACTIONID]

DESCRIPTION
  Get Transaction by Transaction ID

See code: src/commands/transaction/get.ts

proton version

Version of CLI

USAGE
  $ proton version

DESCRIPTION
  Version of CLI

See code: src/commands/version.ts