Proton CLI
Install CLI (NPM)
npm i -g @proton/cli
Install CLI (Yarn)
yarn global add @proton/cli
If you get a missing write access error on Mac/Linux, first run:
sudo chown -R $USER /usr/local/lib/node_modules
sudo chown -R $USER /usr/local/bin
You can skip this step if you already have NodeJS installed
1. Install NVM
MacOS/Linux/WSL:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
Windows 7/10/11:
Download nvm-setup.zip and run it here. After installation, open a new PowerShell window as administrator.
2. Install NodeJS
nvm install 16
nvm use 16
$ npm install -g @proton/cli
$ proton COMMANDrunning command...
$ proton (--version)@proton/cli/0.1.98 darwin-arm64 node-v23.11.0
$ proton --help [COMMAND]USAGE $ proton COMMAND...proton account ACCOUNTproton account:create ACCOUNTproton account:create-funded ACCOUNTproton action CONTRACT [ACTION] [DATA] [AUTHORIZATION]proton block:get BLOCKNUMBERproton boilerplate [FOLDER]proton chain:getproton chain:infoproton chain:listproton chain:set [CHAIN]proton contract:abi ACCOUNTproton contract:clear ACCOUNTproton contract:enableinline ACCOUNTproton contract:set ACCOUNT SOURCEproton encode:name ACCOUNTproton encode:symbol SYMBOL PRECISIONproton endpointproton endpoint:default [ENDPOINT]proton endpoint:getproton endpoint:set [ENDPOINT]proton faucetproton faucet:claim SYMBOL AUTHORIZATIONproton generate:actionproton generate:contract CONTRACTNAMEproton generate:inlineaction ACTIONNAMEproton generate:table TABLENAMEproton help [COMMAND]proton key:add [PRIVATEKEY]proton key:generateproton key:get PUBLICKEYproton key:listproton key:lockproton key:remove [PRIVATEKEY]proton key:resetproton key:reveal-disableproton key:reveal-setupproton key:unlock [PASSWORD]proton msig:approve PROPOSER PROPOSAL AUTHproton msig:cancel PROPOSALNAME AUTHproton msig:exec PROPOSER PROPOSAL AUTHproton msig:propose PROPOSALNAME ACTIONS AUTHproton networkproton permission ACCOUNTproton permission:link ACCOUNT PERMISSION CONTRACT [ACTION]proton permission:unlink ACCOUNT CONTRACT [ACTION]proton psr URIproton ramproton ram:buy BUYER RECEIVER BYTESproton rpc:accountsbyauthorizers AUTHORIZATIONS [KEYS]proton scan ACCOUNTproton table CONTRACT [TABLE] [SCOPE]proton transaction JSONproton transaction:get IDproton transaction:push TRANSACTIONproton version
Get Account Information
USAGE
$ proton account [ACCOUNT] [-r] [-t]
FLAGS
-r, --raw
-t, --tokens Show token balances
DESCRIPTION
Get Account Information
See code: lib/commands/account/index.js
Create New Account
USAGE
$ proton account:create [ACCOUNT]
DESCRIPTION
Create New Account
See code: lib/commands/account/create.js
Create a new account funded by an existing account (no email verification).
USAGE
$ proton account:create-funded [ACCOUNT] -c <value> [-h] [-k <value>] [-r <value>] [-o <value>]
ARGUMENTS
ACCOUNT New account name (4-12 chars, a-z and 1-5 only)
FLAGS
-c, --creator=<value> (required) Existing account that pays for and creates the new account
-h, --help show CLI help
-k, --key=<value> Public key for new account (PUB_K1_... format). Generates new key if omitted
-o, --owner=<value> Account to add as backup owner (can recover/rotate keys if agent key is lost)
-r, --ram=<value> [default: 3000] RAM bytes to purchase for new account (minimum 3000)
DESCRIPTION
Create a new account funded by an existing account (no email verification).
The creator account pays for RAM and signs the transaction.
CPU and NET bandwidth are delegated for free by the network.
Account naming rules:
- Must be 4-12 characters long
- Only lowercase letters a-z and digits 1-5 are allowed
- Periods (.) are allowed but the suffix must be owned by the creator
- Characters 0, 6, 7, 8, 9 are NOT allowed
- Examples: myaccount, agent11111, test.paul
Security:
Use --owner to add a backup account to the owner permission.
This allows the designated owner to recover or rotate keys
on the new account if the generated key is lost or compromised.
The owner permission threshold is set to 1, so either the key
or the owner account can act independently.
Cost: ~6-7 XPR per 3000 bytes of RAM (default).
The creator account must hold enough XPR to cover RAM costs.
EXAMPLES
$ proton account:create-funded myaccount --creator fundingacct
$ proton account:create-funded myaccount -c fundingacct --ram 8192
$ proton account:create-funded myaccount -c fundingacct -k PUB_K1_...
$ proton account:create-funded agentacct -c fundingacct --owner paul123
See code: lib/commands/account/create-funded.js
Execute Action
USAGE
$ proton action [CONTRACT] [ACTION] [DATA] [AUTHORIZATION]
ARGUMENTS
CONTRACT
ACTION
DATA
AUTHORIZATION Account to authorize with
DESCRIPTION
Execute Action
See code: lib/commands/action/index.js
Get Block
USAGE
$ proton block:get [BLOCKNUMBER]
DESCRIPTION
Get Block
See code: lib/commands/block/get.js
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: lib/commands/boilerplate.js
Get Current Chain
USAGE
$ proton chain:get
DESCRIPTION
Get Current Chain
ALIASES
$ proton network
See code: lib/commands/chain/get.js
Get Chain Info
USAGE
$ proton chain:info
DESCRIPTION
Get Chain Info
See code: lib/commands/chain/info.js
All Networks
USAGE
$ proton chain:list
DESCRIPTION
All Networks
See code: lib/commands/chain/list.js
Set Chain
USAGE
$ proton chain:set [CHAIN]
ARGUMENTS
CHAIN Specific chain
DESCRIPTION
Set Chain
See code: lib/commands/chain/set.js
Get Contract ABI
USAGE
$ proton contract:abi [ACCOUNT]
DESCRIPTION
Get Contract ABI
See code: lib/commands/contract/abi.js
Clean Contract
USAGE
$ proton contract:clear [ACCOUNT] [-a] [-w]
FLAGS
-a, --abiOnly Only remove ABI
-w, --wasmOnly Only remove WASM
DESCRIPTION
Clean Contract
See code: lib/commands/contract/clear.js
Enable Inline Actions on a Contract
USAGE
$ proton contract:enableinline [ACCOUNT] [-p <value>]
ARGUMENTS
ACCOUNT Contract account to enable
FLAGS
-p, --authorization=<value> Use a specific authorization other than contract@active
DESCRIPTION
Enable Inline Actions on a Contract
See code: lib/commands/contract/enableinline.js
Deploy Contract (WASM + ABI)
USAGE
$ proton contract:set [ACCOUNT] [SOURCE] [-c] [-a] [-w] [-s]
FLAGS
-a, --abiOnly Only deploy ABI
-c, --clear Removes WASM + ABI from contract
-s, --disableInline Disable inline actions on contract
-w, --wasmOnly Only deploy WASM
DESCRIPTION
Deploy Contract (WASM + ABI)
See code: lib/commands/contract/set.js
Encode Name
USAGE
$ proton encode:name [ACCOUNT]
DESCRIPTION
Encode Name
See code: lib/commands/encode/name.js
Encode Symbol
USAGE
$ proton encode:symbol [SYMBOL] [PRECISION]
DESCRIPTION
Encode Symbol
See code: lib/commands/encode/symbol.js
Get Current enpoint
USAGE
$ proton endpoint
DESCRIPTION
Get Current enpoint
ALIASES
$ proton endpoint
Restore default enpoint
USAGE
$ proton endpoint:default [ENDPOINT]
ARGUMENTS
ENDPOINT Restore default endpoints
DESCRIPTION
Restore default enpoint
See code: lib/commands/endpoint/default.js
Get Current enpoint
USAGE
$ proton endpoint:get
DESCRIPTION
Get Current enpoint
ALIASES
$ proton endpoint
See code: lib/commands/endpoint/get.js
Set current enpoint
USAGE
$ proton endpoint:set [ENDPOINT]
ARGUMENTS
ENDPOINT Specific endpoint
DESCRIPTION
Set current enpoint
See code: lib/commands/endpoint/set.js
List all faucets
USAGE
$ proton faucet
DESCRIPTION
List all faucets
See code: lib/commands/faucet/index.js
Claim faucet
USAGE
$ proton faucet:claim [SYMBOL] [AUTHORIZATION]
ARGUMENTS
SYMBOL
AUTHORIZATION Authorization like account1@active
DESCRIPTION
Claim faucet
See code: lib/commands/faucet/claim.js
Add extra actions to the smart contract
USAGE
$ proton generate:action [-o <value>] [-c <value>]
FLAGS
-c, --contract=<value> The name of the contract for table. 1-12 chars, only lowercase a-z and numbers 1-5 are
possible
-o, --output=<value> The relative path to folder the the contract should be located. Current folder by default.
DESCRIPTION
Add extra actions to the smart contract
See code: lib/commands/generate/action.js
Create new smart contract
USAGE
$ proton generate:contract [CONTRACTNAME] [-o <value>]
ARGUMENTS
CONTRACTNAME The name of the contract. 1-12 chars, only lowercase a-z and numbers 1-5 are possible
FLAGS
-o, --output=<value> The relative path to folder the the contract should be located. Current folder by default.
DESCRIPTION
Create new smart contract
See code: lib/commands/generate/contract.js
Add inline action for the smart contract
USAGE
$ proton generate:inlineaction [ACTIONNAME] [-o <value>] [-c <value>]
ARGUMENTS
ACTIONNAME The name of the inline action's class.
FLAGS
-c, --contract=<value> The name of the contract for table. 1-12 chars, only lowercase a-z and numbers 1-5 are
possible
-o, --output=<value> The relative path to folder the the contract should be located. Current folder by default.
DESCRIPTION
Add inline action for the smart contract
See code: lib/commands/generate/inlineaction.js
Add table for the smart contract
USAGE
$ proton generate:table [TABLENAME] [-t <value>] [-s] [-o <value>] [-c <value>]
ARGUMENTS
TABLENAME The name of the contract's table. 1-12 chars, only lowercase a-z and numbers 1-5 are possible
FLAGS
-c, --contract=<value> The name of the contract for table. 1-12 chars, only lowercase a-z and numbers 1-5 are
possible
-o, --output=<value> The relative path to folder the the contract should be located. Current folder by default.
-s, --singleton Create a singleton table?
-t, --class=<value> The name of Typescript class for the table
DESCRIPTION
Add table for the smart contract
See code: lib/commands/generate/table.js
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
Manage Keys
USAGE
$ proton key:add [PRIVATEKEY]
DESCRIPTION
Manage Keys
See code: lib/commands/key/add.js
Generate Key
USAGE
$ proton key:generate
DESCRIPTION
Generate Key
See code: lib/commands/key/generate.js
Reveal the private key for a saved public key (gated by the reveal password if one is set)
USAGE
$ proton key:get [PUBLICKEY] [-f]
FLAGS
-f, --force Skip the typed confirmation and TTY check. Intended for non-interactive scripts. Does NOT skip the reveal
password if one is set.
DESCRIPTION
Reveal the private key for a saved public key (gated by the reveal password if one is set)
See code: lib/commands/key/get.js
List saved keys. Shows public keys and associated accounts by default; pass --reveal-private to include private keys (gated by the reveal password if one is set).
USAGE
$ proton key:list [-r] [-f]
FLAGS
-f, --force Skip the typed confirmation and TTY check when used with --reveal-private. Intended for
non-interactive scripts. Does NOT skip the reveal password if one is set.
-r, --reveal-private Include private keys in the output (requires the reveal password if set, or a typed confirmation
otherwise)
DESCRIPTION
List saved keys. Shows public keys and associated accounts by default; pass --reveal-private to include private keys
(gated by the reveal password if one is set).
See code: lib/commands/key/list.js
Lock Keys with password
USAGE
$ proton key:lock
DESCRIPTION
Lock Keys with password
See code: lib/commands/key/lock.js
Remove Key
USAGE
$ proton key:remove [PRIVATEKEY]
DESCRIPTION
Remove Key
See code: lib/commands/key/remove.js
Reset password (Caution: deletes all private keys stored)
USAGE
$ proton key:reset
DESCRIPTION
Reset password (Caution: deletes all private keys stored)
See code: lib/commands/key/reset.js
Remove the reveal password (requires entering the current one)
USAGE
$ proton key:reveal-disable
DESCRIPTION
Remove the reveal password (requires entering the current one)
See code: lib/commands/key/reveal-disable.js
Set or change the reveal password required to view private keys via key:get or key:list --reveal-private
USAGE
$ proton key:reveal-setup
DESCRIPTION
Set or change the reveal password required to view private keys via key:get or key:list --reveal-private
See code: lib/commands/key/reveal-setup.js
Unlock all keys (Caution: Your keys will be stored in plaintext on disk)
USAGE
$ proton key:unlock [PASSWORD]
DESCRIPTION
Unlock all keys (Caution: Your keys will be stored in plaintext on disk)
See code: lib/commands/key/unlock.js
Multisig Approve
USAGE
$ proton msig:approve [PROPOSER] [PROPOSAL] [AUTH]
DESCRIPTION
Multisig Approve
See code: lib/commands/msig/approve.js
Multisig Cancel
USAGE
$ proton msig:cancel [PROPOSALNAME] [AUTH]
DESCRIPTION
Multisig Cancel
See code: lib/commands/msig/cancel.js
Multisig Execute
USAGE
$ proton msig:exec [PROPOSER] [PROPOSAL] [AUTH]
DESCRIPTION
Multisig Execute
See code: lib/commands/msig/exec.js
Multisig Propose
USAGE
$ proton msig:propose [PROPOSALNAME] [ACTIONS] [AUTH] [-b <value>] [-x <value>]
FLAGS
-b, --blocksBehind=<value> [default: 30]
-x, --expireSeconds=<value> [default: 604800]
DESCRIPTION
Multisig Propose
See code: lib/commands/msig/propose.js
Get Current Chain
USAGE
$ proton network
DESCRIPTION
Get Current Chain
ALIASES
$ proton network
Update Permission
USAGE
$ proton permission [ACCOUNT]
ARGUMENTS
ACCOUNT Account to modify
DESCRIPTION
Update Permission
See code: lib/commands/permission/index.js
Link Auth
USAGE
$ proton permission:link [ACCOUNT] [PERMISSION] [CONTRACT] [ACTION] [-p <value>]
FLAGS
-p, --permission=<value> Permission to sign with (e.g. account@active)
DESCRIPTION
Link Auth
See code: lib/commands/permission/link.js
Unlink Auth
USAGE
$ proton permission:unlink [ACCOUNT] [CONTRACT] [ACTION] [-p <value>]
FLAGS
-p, --permission=<value>
DESCRIPTION
Unlink Auth
See code: lib/commands/permission/unlink.js
Create Session
USAGE
$ proton psr [URI]
DESCRIPTION
Create Session
See code: lib/commands/psr/index.js
List Ram price
USAGE
$ proton ram
DESCRIPTION
List Ram price
See code: lib/commands/ram/index.js
Buy RAM for an account
USAGE
$ proton ram:buy [BUYER] [RECEIVER] [BYTES] [-p <value>]
ARGUMENTS
BUYER Account paying for RAM
RECEIVER Account receiving RAM
BYTES Number of bytes of RAM to purchase
FLAGS
-p, --authorization=<value> Authorization to use (e.g., account@active). Defaults to buyer@active
DESCRIPTION
Buy RAM for an account
EXAMPLES
$ proton ram:buy myaccount myaccount 10000
$ proton ram:buy payer receiver 50000 -p payer@active
See code: lib/commands/ram/buy.js
Get Accounts by Authorization
USAGE
$ proton rpc:accountsbyauthorizers [AUTHORIZATIONS] [KEYS]
DESCRIPTION
Get Accounts by Authorization
See code: lib/commands/rpc/accountsbyauthorizers.js
Open Account in Proton Scan
USAGE
$ proton scan [ACCOUNT]
DESCRIPTION
Open Account in Proton Scan
See code: lib/commands/scan/index.js
Get Table Storage Rows
USAGE
$ proton table [CONTRACT] [TABLE] [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: lib/commands/table/index.js
Execute Transaction
USAGE
$ proton transaction [JSON]
DESCRIPTION
Execute Transaction
See code: lib/commands/transaction/index.js
Get Transaction by Transaction ID
USAGE
$ proton transaction:get [ID]
DESCRIPTION
Get Transaction by Transaction ID
See code: lib/commands/transaction/get.js
Push Transaction
USAGE
$ proton transaction:push [TRANSACTION] [-u <value>]
FLAGS
-u, --endpoint=<value> Your RPC endpoint
DESCRIPTION
Push Transaction
See code: lib/commands/transaction/push.js
Version of CLI
USAGE
$ proton version
DESCRIPTION
Version of CLI
See code: lib/commands/version.js