Reference 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.

Setting environment variables

How you set a variable depends on your shell. Use the tab for your platform:

# For a single command only
CONSENSUS_NODE_VERSION=v0.73.0 solo one-shot single deploy

# For the current session
export CONSENSUS_NODE_VERSION=v0.73.0

# Persist across sessions (add to ~/.bashrc or ~/.zshrc)
echo 'export CONSENSUS_NODE_VERSION=v0.73.0' >> ~/.zshrc

# For the current session
$env:CONSENSUS_NODE_VERSION = 'v0.73.0'

# Persist for your user (all future sessions)
[System.Environment]::SetEnvironmentVariable('CONSENSUS_NODE_VERSION', 'v0.73.0', 'User')

# Or add it to your PowerShell profile
Add-Content $PROFILE '$env:CONSENSUS_NODE_VERSION = "v0.73.0"'

Tip: Variables set in your shell environment (or persisted as shown above) take effect automatically for all subsequent Solo commands.

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, rapid-fire load start, and consensus node collect-jfr).

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.

CLI Reference

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

Reference on Solo

Solo CLI Reference

Overview

Output Formats (--output, -o)

Using Environment Variables

Overview

Setting environment variables

CLI Migration Reference

Overview

Legacy to Current Mapping

Notes

Falcon Values File Reference

Overview

CLI Reference

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