@celo/celocli
Advanced tools
Tool for transacting with the Celo protocol
$ npm install -g @celo/celocli
$ celocli COMMAND
running command...
$ celocli (-v|--version|version)
@celo/celocli/0.0.2 darwin-x64 node-v8.16.0
$ celocli --help [COMMAND]
USAGE
$ celocli COMMAND
...
celocli account:balance ACCOUNTcelocli account:transferdollarcelocli account:transfergoldcelocli bonds:depositcelocli bonds:list ACCOUNTcelocli bonds:notifycelocli bonds:registercelocli bonds:rewardscelocli bonds:show ACCOUNTcelocli bonds:withdraw AVAILABILITYTIMEcelocli config:getcelocli config:setcelocli faucet ADDRESScelocli help [COMMAND]celocli node:accountscelocli validator:affiliationcelocli validator:listcelocli validator:registercelocli validator:show VALIDATORADDRESScelocli validatorgroup:listcelocli validatorgroup:member VALIDATORADDRESScelocli validatorgroup:registercelocli validatorgroup:show GROUPADDRESScelocli validatorgroup:votecelocli account:balance ACCOUNTView token balances given account address
USAGE
$ celocli account:balance ACCOUNT
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
EXAMPLE
balance 0x5409ed021d9299bf6814279a6a1411a7e866a631
See code: src/commands/account/balance.ts
celocli account:transferdollarTransfer dollar
USAGE
$ celocli account:transferdollar
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
--amountInWei=amountInWei (required) Amount to transfer (in wei)
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender
--to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the receiver
EXAMPLE
transfer --from 0xa0Af2E71cECc248f4a7fD606F203467B500Dd53B --to 0x5409ed021d9299bf6814279a6a1411a7e866a631
--amountInWei 1
See code: src/commands/account/transferdollar.ts
celocli account:transfergoldTransfer gold
USAGE
$ celocli account:transfergold
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
--amountInWei=amountInWei (required) Amount to transfer (in wei)
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender
--to=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the receiver
EXAMPLE
transfer --from 0xa0Af2E71cECc248f4a7fD606F203467B500Dd53B --to 0x5409ed021d9299bf6814279a6a1411a7e866a631
--amountInWei 1
See code: src/commands/account/transfergold.ts
celocli bonds:depositCreate a bonded deposit given notice period and gold amount
USAGE
$ celocli bonds:deposit
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
--from=from (required)
--goldAmount=goldAmount (required) unit amount of gold token (cGLD)
--noticePeriod=noticePeriod (required) duration (seconds) from notice to withdrawable; doubles as ID of a bonded
deposit;
EXAMPLE
deposit --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 --noticePeriod 8640 --goldAmount 1000000000000000000
See code: src/commands/bonds/deposit.ts
celocli bonds:list ACCOUNTView information about all of the account's deposits
USAGE
$ celocli bonds:list ACCOUNT
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
EXAMPLE
list 0x5409ed021d9299bf6814279a6a1411a7e866a631
See code: src/commands/bonds/list.ts
celocli bonds:notifyNotify a bonded deposit given notice period and gold amount
USAGE
$ celocli bonds:notify
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Account Address
--goldAmount=goldAmount (required) unit amount of gold token (cGLD)
--noticePeriod=noticePeriod (required) duration (seconds) from notice to withdrawable; doubles
as ID of a bonded deposit;
EXAMPLE
notify --noticePeriod=3600 --goldAmount=500
See code: src/commands/bonds/notify.ts
celocli bonds:registerRegister an account for bonded deposit eligibility
USAGE
$ celocli bonds:register
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Account Address
EXAMPLE
register
See code: src/commands/bonds/register.ts
celocli bonds:rewardsManage rewards for bonded deposit account
USAGE
$ celocli bonds:rewards
OPTIONS
-d, --delegate=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d Delegate rewards to provided account
-h, --help show CLI help
-l, --logLevel=logLevel
-r, --redeem Redeem accrued rewards from bonded deposits
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Account Address
EXAMPLES
rewards --redeem
rewards --delegate=0x56e172F6CfB6c7D01C1574fa3E2Be7CC73269D95
See code: src/commands/bonds/rewards.ts
celocli bonds:show ACCOUNTView bonded gold and corresponding account weight of a deposit given ID
USAGE
$ celocli bonds:show ACCOUNT
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
--availabilityTime=availabilityTime unix timestamp at which withdrawable; doubles as ID of a notified deposit
--noticePeriod=noticePeriod duration (seconds) from notice to withdrawable; doubles as ID of a bonded
deposit;
EXAMPLES
show 0x5409ed021d9299bf6814279a6a1411a7e866a631 --noticePeriod=3600
show 0x5409ed021d9299bf6814279a6a1411a7e866a631 --availabilityTime=1562206887
See code: src/commands/bonds/show.ts
celocli bonds:withdraw AVAILABILITYTIMEWithdraw notified deposit given availability time
USAGE
$ celocli bonds:withdraw AVAILABILITYTIME
ARGUMENTS
AVAILABILITYTIME unix timestamp at which withdrawable; doubles as ID of a notified deposit
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Account Address
EXAMPLE
withdraw 3600
See code: src/commands/bonds/withdraw.ts
celocli config:getOutput network node configuration
USAGE
$ celocli config:get
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
See code: src/commands/config/get.ts
celocli config:setConfigure running node information for propogating transactions to network
USAGE
$ celocli config:set
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
--node=node (required) [default: ws://localhost:8546] Node URL
See code: src/commands/config/set.ts
celocli faucet ADDRESSFaucet request for an account
USAGE
$ celocli faucet ADDRESS
ARGUMENTS
ADDRESS Address
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
--net=net (required) Name of the network
EXAMPLE
faucet 0x97f7333c51897469E8D98E7af8653aAb468050a3
See code: src/commands/faucet.ts
celocli help [COMMAND]display help for celocli
USAGE
$ celocli help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
celocli node:accountsList node accounts
USAGE
$ celocli node:accounts
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
See code: src/commands/node/accounts.ts
celocli validator:affiliationManage affiliation to a ValidatorGroup
USAGE
$ celocli validator:affiliation
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Validator's address
--set=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d set affiliation to given address
--unset clear affiliation field
EXAMPLES
affiliation --set 0x97f7333c51897469e8d98e7af8653aab468050a3 --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95
affiliation --unset --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95
See code: src/commands/validator/affiliation.ts
celocli validator:listList existing Validators
USAGE
$ celocli validator:list
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
EXAMPLE
list
See code: src/commands/validator/list.ts
celocli validator:registerRegister a new Validator
USAGE
$ celocli validator:register
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address for the Validator
--id=id (required)
--name=name (required)
--noticePeriod=noticePeriod (required) Notice Period for the Bonded deposit to use
--publicKey=0x (required) Public Key
--url=url (required)
EXAMPLE
register --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 --id myID --name myNAme --noticePeriod 5184000 --url
"http://validator.com" --publicKey
0xc52f3fab06e22a54915a8765c4f6826090cfac5e40282b43844bf1c0df83aaa632e55b67869758f2291d1aabe0ebecc7cbf4236aaa45e3e0cfbf
997eda082ae1
See code: src/commands/validator/register.ts
celocli validator:show VALIDATORADDRESSShow information about an existing Validator
USAGE
$ celocli validator:show VALIDATORADDRESS
ARGUMENTS
VALIDATORADDRESS Validator's address
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
EXAMPLE
show 0x97f7333c51897469E8D98E7af8653aAb468050a3
See code: src/commands/validator/show.ts
celocli validatorgroup:listList existing Validator Groups
USAGE
$ celocli validatorgroup:list
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
EXAMPLE
list
See code: src/commands/validatorgroup/list.ts
celocli validatorgroup:member VALIDATORADDRESSRegister a new Validator Group
USAGE
$ celocli validatorgroup:member VALIDATORADDRESS
ARGUMENTS
VALIDATORADDRESS Validator's address
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
--accept Accept a validatior whose affiliation is already set to the vgroup
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) ValidatorGroup's address
--remove Remove a validatior from the members list
EXAMPLES
member --accept 0x97f7333c51897469e8d98e7af8653aab468050a3
member --remove 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95
See code: src/commands/validatorgroup/member.ts
celocli validatorgroup:registerRegister a new Validator Group
USAGE
$ celocli validatorgroup:register
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address for the Validator Group
--id=id (required)
--name=name (required)
--noticePeriod=noticePeriod (required) Notice Period for the Bonded deposit to use
--url=url (required)
EXAMPLE
register --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 --id myID --name myNAme --noticePeriod 5184000 --url
"http://vgroup.com"
See code: src/commands/validatorgroup/register.ts
celocli validatorgroup:show GROUPADDRESSShow information about an existing Validator Group
USAGE
$ celocli validatorgroup:show GROUPADDRESS
ARGUMENTS
GROUPADDRESS ValidatorGroup's address
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
EXAMPLE
show 0x97f7333c51897469E8D98E7af8653aAb468050a3
See code: src/commands/validatorgroup/show.ts
celocli validatorgroup:voteVote for a Validator Group
USAGE
$ celocli validatorgroup:vote
OPTIONS
-h, --help show CLI help
-l, --logLevel=logLevel
--current Show voter's current vote
--for=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d Set vote for ValidatorGroup's address
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Voter's address
--revoke Revoke voter's current vote
EXAMPLES
vote --from 0x4443d0349e8b3075cba511a0a87796597602a0f1 --for 0x932fee04521f5fcb21949041bf161917da3f588b
vote --from 0x4443d0349e8b3075cba511a0a87796597602a0f1 --revoke
vote --from 0x4443d0349e8b3075cba511a0a87796597602a0f1 --current
See code: src/commands/validatorgroup/vote.ts
FAQs
CLI Tool for transacting with the Celo protocol
The npm package @celo/celocli receives a total of 253 weekly downloads. As such, @celo/celocli popularity was classified as not popular.
We found that @celo/celocli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.