Merod

Merod is a command-line tool that allows you to initialize, configure and run Calimero nodes.

Installation

You can choose to install merod using either the installation script or Homebrew.

Homebrew

If you use Homebrew, you can install merod directly with the following steps:

Steps

1. Add the Calimero Homebrew tap:

   brew tap calimero-network/homebrew-tap

2. Install merod:

   brew install merod

3. Verify the installation:

   merod --version

If the version number appears, the installation was successful.

Installation Script

The installation script supports multiple terminal environments and will automatically configure your PATH based on your shell.

Steps

1. Open your terminal and run:

   curl -sSf https://raw.githubusercontent.com/calimero-network/core/master/scripts/install-merod.sh | bash

2. Source the updated PATH:

   source <your-shell-config-file>

   Replace <your-shell-config-file> with .bashrc, .zshrc, or the relevant configuration file for your shell.

3. Verify the installation:

   merod --version

If the version number appears, the installation was successful.

Notes for Shell Environments

The script automatically updates your PATH based on your shell configuration:

• Bash: Updates .bashrc.
• Zsh: Updates .zshrc.
• Fish: Modifies ~/.config/fish/config.fish.
• Csh/Tcsh: Updates .cshrc.

To apply the changes immediately, use the source command as described in step 2 above.

Usage

Terminal

merod [OPTIONS] --node-name <NAME> <COMMAND>

Commands:

• config Configure the node
• init Initialize node configuration
• run Run a node
• relay Relay incoming requests to specific location
• help Print this message or the help of the given subcommand(s)

tip

Run help to get more information about the available options and commands.

Terminal

merod --help

Options:

• --home <PATH> Directory for config and data
• -n, --node-name <NAME> Name of node
• -h, --help Print help
• -V, --version Print version

tip

Default location of the config and data directory is ~/.calimero. You can change the location by using the --home option.

Examples:

Command	Description
merod --node-name node1 init	Initialize a node with default settings. (server-port = 2428 and swarm-port = 2528`)
merod --node-name node1 init --server-port 2429 --swarm-port 2529	Initialize a node with custom ports.
mkdir data && merod --home data/ --node-name node1 init	Initialize a node with a custom home directory.
merod --node-name node1 config --server-host 143.34.182.202 --server-port 3000	Configure an existing node with a specific server host and port.
merod --node-name node1 run	Run a node.
merod --node-name node2 relay --listen 127.0.0.1:3333	Relay incoming requests to a specific location.