@protonprotocol/cli

Proton CLI

• Installation
• Usage
• Commands

Installation

From Scratch

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

NPM

npm i -g @protonprotocol/cli

yarn

yarn global add @protonprotocol/cli

Usage

$ npm install -g @protonprotocol/cli
$ proton COMMAND
running command...
$ proton (-v|--version|version)
@protonprotocol/cli/0.3.48 darwin-x64 node-v12.19.0
$ proton --help [COMMAND]
USAGE
  $ proton COMMAND
...

Commands

• proton boilerplate [FOLDER]
• proton generate:key
• proton help [COMMAND]
• proton install [VERSION]
• proton network:all
• proton network:get
• proton network:set CHAIN
• proton set:contract ACCOUNT DIRECTORY
• proton system:dappreg ACCOUNT
• proton system:newaccount ACCOUNT OWNER ACTIVE
• proton version
• proton wallet:create [NAME]
• proton wallet:createkey [NAME] [TYPE]
• proton wallet:importkey [NAME] [PRIVATE_KEY]
• proton wallet:list
• proton wallet:listprivatekeys [NAME]
• proton wallet:listpublickeys
• proton wallet:lock [NAME]
• proton wallet:lockall
• proton wallet:open [NAME]
• proton wallet:removekey [NAME] [PUBLIC_KEY]
• proton wallet:stopkeosd
• proton wallet:unlock [NAME]

proton boilerplate [FOLDER]

Boilerplate a new Proton Project with contract, frontend and tests

USAGE
  $ proton boilerplate [FOLDER]

OPTIONS
  -h, --help  show CLI help

See code: src/commands/boilerplate.ts

proton generate:key

Generate Key

USAGE
  $ proton generate:key

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

proton help [COMMAND]

display help for proton

USAGE
  $ proton help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

proton install [VERSION]

Install nodeos, cleos and keosd software

USAGE
  $ proton install [VERSION]

ARGUMENTS
  VERSION  [default: 2.1.0-rc1] EOSIO version

See code: src/commands/install.ts

proton network:all

All Networks

USAGE
  $ proton network:all

See code: src/commands/network/all.ts

proton network:get

Get Current Network

USAGE
  $ proton network:get

ALIASES
  $ proton network

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

proton network:set CHAIN

Set Current Network

USAGE
  $ proton network:set CHAIN

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

proton set:contract ACCOUNT DIRECTORY

Set Contract

USAGE
  $ proton set:contract ACCOUNT DIRECTORY

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

proton system:dappreg ACCOUNT

Set Contract

USAGE
  $ proton system:dappreg ACCOUNT

See code: src/commands/system/dappreg.ts

proton system:newaccount ACCOUNT OWNER ACTIVE

System NewAccount

USAGE
  $ proton system:newaccount ACCOUNT OWNER ACTIVE

OPTIONS
  -c, --cpu=cpu   [default: 10.0000 SYS]
  -h, --help      show CLI help
  -n, --net=net   [default: 10.0000 SYS]
  -r, --ram=ram   [default: 12288]
  -t, --transfer
  --code

See code: src/commands/system/newaccount.ts

proton version

Version of CLI

USAGE
  $ proton version

See code: src/commands/version.ts

proton wallet:create [NAME]

Create new local wallet

USAGE
  $ proton wallet:create [NAME]

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

proton wallet:createkey [NAME] [TYPE]

Create key in wallet

USAGE
  $ proton wallet:createkey [NAME] [TYPE]

See code: src/commands/wallet/createkey.ts

proton wallet:importkey [NAME] [PRIVATE_KEY]

Import private key to wallet

USAGE
  $ proton wallet:importkey [NAME] [PRIVATE_KEY]

See code: src/commands/wallet/importkey.ts

proton wallet:list

List open wallets

USAGE
  $ proton wallet:list

ALIASES
  $ proton wallet

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

proton wallet:listprivatekeys [NAME]

List private keys for a single wallet

USAGE
  $ proton wallet:listprivatekeys [NAME]

See code: src/commands/wallet/listprivatekeys.ts

proton wallet:listpublickeys

List public keys for all wallets

USAGE
  $ proton wallet:listpublickeys

See code: src/commands/wallet/listpublickeys.ts

proton wallet:lock [NAME]

Lock local wallet

USAGE
  $ proton wallet:lock [NAME]

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

proton wallet:lockall

Lock all local wallets

USAGE
  $ proton wallet:lockall

See code: src/commands/wallet/lockall.ts

proton wallet:open [NAME]

Open local wallet

USAGE
  $ proton wallet:open [NAME]

See code: src/commands/wallet/open.ts

proton wallet:removekey [NAME] [PUBLIC_KEY]

Remove private key from wallet

USAGE
  $ proton wallet:removekey [NAME] [PUBLIC_KEY]

See code: src/commands/wallet/removekey.ts

proton wallet:stopkeosd

Stops Keosd

USAGE
  $ proton wallet:stopkeosd

See code: src/commands/wallet/stopkeosd.ts

proton wallet:unlock [NAME]

Unlock local wallet

USAGE
  $ proton wallet:unlock [NAME]

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