CLI command reference
This section contains information about all commands and settings available in the Chromia CLI, including examples and flags.
Set up auto completion
The command chr --generate-completion [bash|zsh|fish] generates shell-specific completion scripts. It enhances the
command-line experience when using the chr command by providing auto-completion suggestions for command names,
options, and arguments.
You need to provide one of the specified shell options (bash, zsh, or fish) to indicate which type of completion
script you want to generate. You have to choose the corresponding option depending on the shell you use.
For example:
chr --generate-completion bash >> ~/chr.shgenerates a file with Bash completion script for thechrcommand.chr --generate-completion zsh >> ~/chr.zshgenerates a file with Zsh completion script for thechrcommand.chr --generate-completion fish >> ~/chr.fishgenerates a file with Fish completion script for thechrcommand.
These generated files shall then be sourced or included in your respective shell configuration files (such as .bashrc,
.zshrc, or config.fish) to enable auto-completion for the chr command whenever you use that shell.
chr help.versionShow the current CLI version with chr version.buildRun the chr build command to create a blockchain configuration for your dapp.create-rell-dappUse chr create-rell-dapp to generate a new Rell-based "Hello World" project.deploymentManage blockchain deployments with the chr deployment command.eifThe chr eif command provides access to Ethereum Integration Framework functionalities.generateGenerate client stubs and documentation for your Rell project using chr generate.libraryDownload and use third-party Rell libraries in your dapp with chr library install.keygenCreate a public and private key pair using the chr keygen command.nodeStart or update a node running your applications using chr node.queryTest and interact with local or deployed chains without a client using chr query.replRun Rell methods interactively in the shell with chr repl, ideal for troubleshooting.testExecute project-specific tests defined in chromia.yml with chr test.txSign and run transactions with chr tx, similar to the query command.codeManage code quality, including formatting and linting, using chr code.multi-signatureHandle multi-signer transactions using the chr multi-signature command.toolsAccess various utilities and tools for Chromia development with chr tools.seederGenerate mock data for a local database with chr seeder.