Cli on Solo

Solo CLI Reference

Mon, 01 Jan 0001 00:00:00 +0000

Overview

This page is the canonical command reference for the Solo CLI.

Use it to look up command paths, subcommands, and flags.
Use solo <command> --help and solo <command> <subcommand> --help for runtime help on your installed version.
For legacy command mappings, see CLI Migration Reference.

Output Formats (`--output`, `-o`)

Solo supports machine-readable output for version output and for command execution flows that honor the output format flag.

Using Environment Variables

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Solo supports a set of environment variables that let you customize its behaviour without modifying command-line flags on every run. Variables set in your shell environment take effect automatically for all subsequent Solo commands.

Tip: Add frequently used variables to your shell profile (e.g. ~/.zshrc or ~/.bashrc) to persist them across sessions.

General

Environment Variable	Description	Default Value
`SOLO_HOME`	Path to the Solo cache and log files	`~/.solo`
`SOLO_CACHE_DIR`	Path to the Solo cache directory	`~/.solo/cache`
`SOLO_LOG_LEVEL`	Logging level for Solo operations. Accepted values: `trace`, `debug`, `info`, `warn`, `error`	`info`
`SOLO_DEV_OUTPUT`	Treat all commands as if the `--dev` flag were specified	`false`
`SOLO_CHAIN_ID`	Chain ID of the Solo network	`298`
`FORCE_PODMAN`	Force the use of Podman as the container engine when creating a new local cluster. Accepted values: `true`, `false`	`false`

Network and Node Identity

Environment Variable	Description	Default Value
`DEFAULT_START_ID_NUMBER`	First node account ID of the Solo test network	`0.0.3`
`SOLO_NODE_INTERNAL_GOSSIP_PORT`	Internal gossip port used by the Hiero network	`50111`
`SOLO_NODE_EXTERNAL_GOSSIP_PORT`	External gossip port used by the Hiero network	`50111`
`SOLO_NODE_DEFAULT_STAKE_AMOUNT`	Default stake amount for a node	`500`
`GRPC_PORT`	gRPC port used for local node communication	`50211`
`LOCAL_NODE_START_PORT`	Local node start port for the Solo network	`30212`
`SOLO_CHAIN_ID`	Chain ID of the Solo network	`298`

Operator and Key Configuration

Environment Variable	Description	Default Value
`SOLO_OPERATOR_ID`	Operator account ID for the Solo network	`0.0.2`
`SOLO_OPERATOR_KEY`	Operator private key for the Solo network	`302e020100...`
`SOLO_OPERATOR_PUBLIC_KEY`	Operator public key for the Solo network	`302a300506...`
`FREEZE_ADMIN_ACCOUNT`	Freeze admin account ID for the Solo network	`0.0.58`
`GENESIS_KEY`	Genesis private key for the Solo network	`302e020100...`

Note: Full key values are omitted above for readability. Refer to the source defaults for complete key strings.

CLI Migration Reference

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Use this page when migrating scripts or runbooks from legacy Solo CLI command paths (< v0.44.0) to the current command structure.

For full current syntax and flags, see Solo CLI Reference.

Legacy to Current Mapping

Legacy command	Current command
`init`	`init`
`block node add`	`block node add`
`block node destroy`	`block node destroy`
`block node upgrade`	`block node upgrade`
`account init`	`ledger system init`
`account update`	`ledger account update`
`account create`	`ledger account create`
`account get`	`ledger account info`
`quick-start single deploy`	`one-shot single deploy`
`quick-start single destroy`	`one-shot single destroy`
`cluster-ref connect`	`cluster-ref config connect`
`cluster-ref disconnect`	`cluster-ref config disconnect`
`cluster-ref list`	`cluster-ref config list`
`cluster-ref info`	`cluster-ref config info`
`cluster-ref setup`	`cluster-ref config setup`
`cluster-ref reset`	`cluster-ref config reset`
`deployment add-cluster`	`deployment cluster attach`
`deployment list`	`deployment config list`
`deployment create`	`deployment config create`
`deployment delete`	`deployment config delete`
`explorer deploy`	`explorer node add`
`explorer destroy`	`explorer node destroy`
`mirror-node deploy`	`mirror node add`
`mirror-node destroy`	`mirror node destroy`
`relay deploy`	`relay node add`
`relay destroy`	`relay node destroy`
`network deploy`	`consensus network deploy`
`network destroy`	`consensus network destroy`
`node keys`	`keys consensus generate`
`node freeze`	`consensus network freeze`
`node upgrade`	`consensus network upgrade`
`node setup`	`consensus node setup`
`node start`	`consensus node start`
`node stop`	`consensus node stop`
`node restart`	`consensus node restart`
`node refresh`	`consensus node refresh`
`node add`	`consensus node add`
`node update`	`consensus node update`
`node delete`	`consensus node destroy`
`node add-prepare`	`consensus dev-node-add prepare`
`node add-submit-transaction`	`consensus dev-node-add submit-transactions`
`node add-execute`	`consensus dev-node-add execute`
`node update-prepare`	`consensus dev-node-update prepare`
`node update-submit-transaction`	`consensus dev-node-update submit-transactions`
`node update-execute`	`consensus dev-node-update execute`
`node upgrade-prepare`	`consensus dev-node-upgrade prepare`
`node upgrade-submit-transaction`	`consensus dev-node-upgrade submit-transactions`
`node upgrade-execute`	`consensus dev-node-upgrade execute`
`node delete-prepare`	`consensus dev-node-delete prepare`
`node delete-submit-transaction`	`consensus dev-node-delete submit-transactions`
`node delete-execute`	`consensus dev-node-delete execute`
`node prepare-upgrade`	`consensus dev-freeze prepare-upgrade`
`node freeze-upgrade`	`consensus dev-freeze freeze-upgrade`
`node logs`	`deployment diagnostics logs`
`node download-generated-files`	No direct equivalent. Use `deployment diagnostics all` or `deployment diagnostics debug` based on intent.
`node states`	`consensus state download`

Notes

Current command tree includes additional commands not present in legacy CLI (for example ledger account predefined, deployment refresh port-forwards, and consensus node collect-jfr).
Legacy mappings are intended for migration support only. Prefer documenting and scripting the current command paths.

Falcon Values File Reference

Mon, 01 Jan 0001 00:00:00 +0000

Overview

This page catalogs the Solo CLI flags accepted under each top-level section of a Falcon values file. Each entry corresponds to the command-line flag that the underlying Solo subcommand accepts.

Sections map to subcommands as follows:

Section	Solo subcommand
`network`	`solo consensus network deploy`
`setup`	`solo consensus node setup`
`consensusNode`	`solo consensus node start`
`mirrorNode`	`solo mirror node add`
`explorerNode`	`solo explorer node add`
`relayNode`	`solo relay node add`
`blockNode`	`solo block node add`

All flag names must be written in long form with double dashes (for example, --release-tag). Flags left empty ("") or matching their default value are ignored by Solo at argument expansion time.

Quickstart

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Solo Quickstart provides a single, one-shot command path to deploy a running Hiero test network using the Solo CLI tool. This guide covers installing Solo, running the one-shot deployment, verifying the network, and accessing local service endpoints.

Note: This guide assumes basic familiarity with command-line interfaces and Docker.

Prerequisites

Before you begin, ensure you have completed the following:

System Readiness:
- Prepare your local environment (Docker, Kind, Kubernetes, and related tooling) by following the System Readiness guide.

Note: Quickstart only covers what you need to run solo one-shot single deploy and verify that the network is working. Detailed version requirements, OS-specific notes, and optional tools are documented in System Readiness.

Managing Your Network

Mon, 01 Jan 0001 00:00:00 +0000

Overview

This guide covers day-to-day management operations for a running Solo network, including starting, stopping, and restarting nodes, capturing logs, and upgrading the network.

Prerequisites

Before proceeding, ensure you have completed the following:

System Readiness - your local environment meets all hardware and software requirements.
Quickstart - you have a running Solo network deployed using solo one-shot single deploy.

Find Your Deployment Name

Most management commands require your deployment name. Run the following command to retrieve it:

Step-by-Step Manual Deployment

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Manual deployment lets you deploy each Solo network component individually, giving you full control over configuration, sequencing, and troubleshooting. Use this approach when you need to customise specific steps, debug a component in isolation, or integrate Solo into a bespoke automation pipeline.

Prerequisites

Before proceeding, ensure you have completed the following:

System Readiness — your local environment meets all hardware and software requirements (Docker, kind, kubectl, helm, Solo).

Cleanup

Mon, 01 Jan 0001 00:00:00 +0000

Overview

This guide covers how to tear down a Solo network deployment, understand resource usage, and perform a full reset when needed.

Prerequisites

Before proceeding, ensure you have completed the following:

Quickstart — you have a running Solo network deployed using solo one-shot single deploy.

Destroying Your Network

Important: Always destroy your network before deploying a new one to avoid conflicts and errors.

To remove your Solo network:

Community Contributions

Mon, 01 Jan 0001 00:00:00 +0000

How to Contribute to Solo

This document describes how to set up a local development environment and contribute to the Solo project.

Prerequisites

Node.js (use the version specified in the repository, if applicable)
npm
Docker or Podman
Kubernetes (local cluster such as kind, k3d, or equivalent)
task (Taskfile runner)
Git
K9s (optional)

Initial setup

Clone the repository:

git clone https://github.com/hiero-ledger/solo.git
cd solo

Install dependencies:

CLI Reference

Mon, 01 Jan 0001 00:00:00 +0000

Documentation

Mon, 01 Jan 0001 00:00:00 +0000

This documentation provides a comprehensive guide to using Solo to launch a Hiero Consensus Node network, including setup instructions, usage guides, and information for developers. It covers everything from installation to advanced features and troubleshooting.

Cli on Solo

Solo CLI Reference

Overview

Output Formats (--output, -o)

Using Environment Variables

Overview

General

Network and Node Identity

Operator and Key Configuration

CLI Migration Reference

Overview

Legacy to Current Mapping

Notes

Falcon Values File Reference

Overview

Quickstart

Overview

Prerequisites

Managing Your Network

Overview

Prerequisites

Find Your Deployment Name

Step-by-Step Manual Deployment

Overview

Prerequisites

Cleanup

Overview

Prerequisites

Destroying Your Network

Community Contributions

How to Contribute to Solo

Prerequisites

Initial setup

CLI Reference

Documentation

Output Formats (`--output`, `-o`)