CLI command reference

This section contains information about all commands and settings available in the Chromia CLI, including examples and flags.

note

The default option of using Chromia CLI to interact with the Chromia blockchain is --use-db. If you want to use it without the database, then use --no-db.

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.sh generates a file with Bash completion script for the chr command.
• chr --generate-completion zsh >> ~/chr.zsh generates a file with Zsh completion script for the chr command.
• chr --generate-completion fish >> ~/chr.fish generates a file with Fish completion script for the chr command.

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.

note

You can also use the first two letters of each command and subcommands as a command shortcut. For example, chr de cr is the same as chr deployment create.

build

Run the chr build command to create a blockchain configuration for your dapp.

create-rell-dapp

Use chr create-rell-dapp to generate a new Rell-based "Hello World" project.

deployment

Manage blockchain deployments with the chr deployment command.

eif

The chr eif command provides access to Ethereum Integration Framework functionalities.

generate

Generate client stubs and documentation for your Rell project using chr generate.

install

Download and use third-party Rell libraries in your dapp with chr install.

keygen

Create a public and private key pair using the chr keygen command.

node

Start or update a node running your applications using chr node.

query

Test and interact with local or deployed chains without a client using chr query.

repl

Run Rell methods interactively in the shell with chr repl, ideal for troubleshooting.

test

Execute project-specific tests defined in chromia.yml with chr test.

tx

Sign and run transactions with chr tx, similar to the query command.

code

Manage code quality, including formatting and linting, using chr code.

multi-signature

Handle multi-signer transactions using the chr multi-signature command.

tools

Access various utilities and tools for Chromia development with chr tools.