Skip to main content Celo has become an L2. Learn how to run a node. Celo Logo Docs What is Celo Build on Celo Tooling Celo L2 More English Support
Overview Network Information Nodes Contracts Wallets Bridging Cross Chain Messaging Explorers Indexers Dev Environments Libraries & SDKs Overview CLI Introduction Account Config DKG Election Epochs Exchange Governance Identity LockedCelo LockedGold Multisig Network Node Oracle Release CELO Rewards Transfer Validator Validator Group Autocomplete Commands Help Plugins viem thirdweb SDK Ethers.js Web3Modal SDK Particle Network ContractKit rainbowkit-celo (deprectated) Web3.js (deprecated) Faucet Verification Oracles Fee Abstraction Libraries & SDKsCLIIntroduction Celo CLI Introduction to the Celo Command Line Interface and installation instructions.
What is the Celo CLI The Command Line Interface allows users to interact with the Celo Protocol smart contracts.
It’s a command-line interface for interacting with the Celo Protocol and core contracts. Some common features you may want try include transferring tokens, viewing account balances, participating in elections or in on-chain governance, voting for validators, or helping users interact with multi-sig contracts.
Installation Homebrew If you're on macOS or Linux, celocli is available as a tap on Homebrew.
brew tap celo-org/brew brew install celocli
celocli --version
NPM Package The Celo CLI is published as a node module on NPM. Assuming you have npm and git both installed, you can install the Celo CLI using the following command:
npm install -g @celo/celocli
If you want the cutting edge, @betas are distributed via npm. npm install -g @celo/celocli@beta
info If you have trouble installing globally (i.e. with the -g flag), try installing to a local directory instead with yarn add @celo/celocli and run with yarn celocli.
Commands The tool is broken down into modules and commands with the following pattern:
celocli : <...args> <...flags?>
The celocli tool assumes that users are running a node which they have access to signing transactions on, or have another mechanism for signing transactions (such as a Ledger wallet or supplying the private key as an argument to the command). See the documentation on the config module for information about how to set which node commands are sent to.
info All balances of CELO or Celo Dollars are expressed in units of 10^-18.
You can find the Celo CLI package on NPM here.
To see all available commands, run celocli commands.
To see all available flags for a command, add the flag --globalHelp to the command.
Optional: Run a Full Node Commands need to connect to a Celo node to execute most functionality. You can either use Forno (this is the easiest way) or run your own full node if you prefer. See the Running a Full Node instructions for more details on running a full node.
The easiest way to connect celocli to the Celo network is by running the following command in your terminal with celocli installed:
celocli config:set --node=https://forno.celo.org
You can verify that celocli is connected by running
celocli config:get
Import Accounts If you are connecting to a remote node (like Forno), Celo CLI will need to sign transactions locally before sending them. To do this, Celo CLI needs access to a private key. There are a couple ways to sign transactions using Celo CLI.
Import Private Key (less secure) Add the --privateKey flag followed by the private key associated with the sending account. For example:
celocli transfer:celo --from --to --value --privateKey --node https://forno.celo.org
Or you can use a Ledger hardware wallet. (preferred, see below)
Using a Ledger Wallet The Celo CLI supports using a Ledger hardware wallet to sign transactions. Just add the --useLedger flag to a command that requires a signature.
You can specify the number of addresses to get for local signing with the --ledgerAddresses flag.
You can specify an array of index addresses for local signing. Example --ledgerCustomAddresses "[4,99]".
For example:
celocli transfer:celo --to --value 1000000 --from --useLedger
Edit this page Previous Overview Next Account What is the Celo CLI Installation Homebrew NPM Package Commands Optional: Run a Full Node Import Accounts Import Private Key (less secure) Using a Ledger Wallet Docs Home Docs GitHub Community Contributors Forum Discord X Reddit Celo Signal Mailing List Celo Signal Calendar Community Calendar Ecosystem Celo Foundation Medium Blog The Celo Celo Hub Careers Copyright © 2025 Celo Foundation, Inc. Built with Docusaurus.
94.06M