Solo CLI Commands
This document provides a comprehensive reference for the Solo CLI commands, including their options and usage.
Solo Command Reference
Table of Contents
Root Help Output
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts --help
Select a command
Usage:
solo <command> [options]
Commands:
init Initialize local environment
block Block Node operations for creating, modifying, and destroying resources. These commands require the presence of an existing deployment.
cluster-ref Manages the relationship between Kubernetes context names and Solo cluster references which are an alias for a kubernetes context.
consensus Consensus Node operations for creating, modifying, and destroying resources. These commands require the presence of an existing deployment.
deployment Create, modify, and delete deployment configurations. Deployments are required for most of the other commands.
explorer Explorer Node operations for creating, modifying, and destroying resources.These commands require the presence of an existing deployment.
keys Consensus key generation operations
ledger System, Account, and Crypto ledger-based management operations. These commands require an operational set of consensus nodes and may require an operational mirror node.
mirror Mirror Node operations for creating, modifying, and destroying resources. These commands require the presence of an existing deployment.
relay RPC Relay Node operations for creating, modifying, and destroying resources. These commands require the presence of an existing deployment.
quick-start Quick start commands for new and returning users who need a preset environment type. These commands use reasonable defaults to provide a single command out of box experience.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access [boolean] [default: true]
the network services
-v, --version Show version number [boolean]
init
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts init --help
init
Initialize local environment
Options:
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access [boolean] [default: true]
the network services
-q, --quiet-mode Quiet mode, do not prompt for [boolean] [default: false]
confirmation
-u, --user Optional user name used for [string]
local configuration. Only
accepts letters and numbers.
Defaults to the username
provided by the OS
-v, --version Show version number [boolean]
block
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts block --help
block
Block Node operations for creating, modifying, and destroying resources. These commands require the presence of an existing deployment.
Commands:
block node Create, manage, or destroy block node instances. Operates on a single block node instance at a time.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
block node
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts block node --help
block node
Create, manage, or destroy block node instances. Operates on a single block node instance at a time.
Commands:
block node add Creates and configures a new block node instance for the specified deployment using the specified Kubernetes cluster. The cluster must be accessible and attached to the specified deployment.
block node destroy Destroys a single block node instance in the specified deployment. Requires access to all Kubernetes clusters attached to the deployment.
block node upgrade Upgrades a single block node instance in the specified deployment. Requires access to all Kubernetes clusters attached to the deployment.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
block node add
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts block node add --help
block node add
Creates and configures a new block node instance for the specified deployment using the specified Kubernetes cluster. The cluster must be accessible and attached to the specified deployment.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
--chart-version Block nodes chart version [string] [default: "v0.14.0"]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
--domain-name Custom domain name [string]
--enable-ingress enable ingress on the component/pod [boolean] [default: false]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-f, --values-file Comma separated chart values file [string]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
--image-tag The Docker image tag to override what is in the Helm Chart [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
block node destroy
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts block node destroy --help
block node destroy
Destroys a single block node instance in the specified deployment. Requires access to all Kubernetes clusters attached to the deployment.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
--force Force actions even if those can be skipped [boolean] [default: false]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
block node upgrade
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts block node upgrade --help
block node upgrade
Upgrades a single block node instance in the specified deployment. Requires access to all Kubernetes clusters attached to the deployment.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
--force Force actions even if those can be skipped [boolean] [default: false]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-f, --values-file Comma separated chart values file [string]
--upgrade-version Version to be used for the upgrade [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
cluster-ref
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts cluster-ref --help
cluster-ref
Manages the relationship between Kubernetes context names and Solo cluster references which are an alias for a kubernetes context.
Commands:
cluster-ref config List, create, manage, and remove associations between Kubernetes contexts and Solo cluster references.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
cluster-ref config
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts cluster-ref config --help
cluster-ref config
List, create, manage, and remove associations between Kubernetes contexts and Solo cluster references.
Commands:
cluster-ref config connect Creates a new internal Solo cluster name to a Kubernetes context or maps a Kubernetes context to an existing internal Solo cluster reference
cluster-ref config disconnect Removes the Kubernetes context associated with an internal Solo cluster reference.
cluster-ref config list Lists the configured Kubernetes context to Solo cluster reference mappings.
cluster-ref config info Displays the status information and attached deployments for a given Solo cluster reference mapping.
cluster-ref config setup Setup cluster with shared components
cluster-ref config reset Uninstall shared components from cluster
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
cluster-ref config connect
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts cluster-ref config connect --help
cluster-ref config connect
Creates a new internal Solo cluster name to a Kubernetes context or maps a Kubernetes context to an existing internal Solo cluster reference
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
--context The Kubernetes context name to be used [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
cluster-ref config disconnect
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts cluster-ref config disconnect --help
cluster-ref config disconnect
Removes the Kubernetes context associated with an internal Solo cluster reference.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
cluster-ref config list
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts cluster-ref config list --help
cluster-ref config list
Lists the configured Kubernetes context to Solo cluster reference mappings.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
cluster-ref config info
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts cluster-ref config info --help
cluster-ref config info
Displays the status information and attached deployments for a given Solo cluster reference mapping.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
cluster-ref config setup
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts cluster-ref config setup --help
cluster-ref config setup
Setup cluster with shared components
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
-s, --cluster-setup-namespace Cluster Setup Namespace [string] [default: "solo-setup"]
--minio Deploy minio operator [boolean] [default: true]
--prometheus-stack Deploy prometheus stack [boolean] [default: false]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--solo-chart-version Solo testing chart version [string] [default: "0.56.0"]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
cluster-ref config reset
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts cluster-ref config reset --help
cluster-ref config reset
Uninstall shared components from cluster
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
-s, --cluster-setup-namespace Cluster Setup Namespace [string] [default: "solo-setup"]
--force Force actions even if those can be skipped [boolean] [default: false]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus --help
consensus
Consensus Node operations for creating, modifying, and destroying resources. These commands require the presence of an existing deployment.
Commands:
consensus network Ledger/network wide consensus operations such as freeze, upgrade, and deploy. Operates on the entire ledger and all consensus node instances.
consensus node List, create, manage, or destroy consensus node instances. Operates on a single consensus node instance at a time.
consensus state List, download, and upload consensus node state backups to/from individual consensus node instances.
consensus diagnostics Capture diagnostic information such as logs, signed states, and ledger/network/node configurations.
consensus dev-node-add Dev operations for adding consensus nodes.
consensus dev-node-update Dev operations for updating consensus nodes
consensus dev-node-upgrade Dev operations for upgrading consensus nodes
consensus dev-node-delete Dev operations for delete consensus nodes
consensus dev-freeze Dev operations for freezing consensus nodes
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus network
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus network --help
consensus network
Ledger/network wide consensus operations such as freeze, upgrade, and deploy. Operates on the entire ledger and all consensus node instances.
Commands:
consensus network deploy Installs and configures all consensus nodes for the deployment.
consensus network destroy Removes all consensus network components from the deployment.
consensus network freeze Initiates a network freeze for scheduled maintenance or upgrades
consensus network upgrade Upgrades the software version running on all consensus nodes.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus network deploy
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus network deploy --help
consensus network deploy
Installs and configures all consensus nodes for the deployment.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--api-permission-properties api-permission.properties file for node [string] [default: "templates/api-permission.properties"]
--app Testing app name [string] [default: "HederaNode.jar"]
--application-env the application.env file for the node provides environment variables to the solo-container to be used when the hedera platform is started [string] [default: "templates/application.env"]
--application-properties application.properties file for node [string] [default: "templates/application.properties"]
--bootstrap-properties bootstrap.properties file for node [string] [default: "templates/bootstrap.properties"]
--genesis-throttles-file throttles.json file used during network genesis [string]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
-l, --ledger-id Ledger ID (a.k.a. Chain ID) [string] [default: "298"]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
--prometheus-svc-monitor Enable prometheus service monitor for the network nodes [boolean] [default: false]
--solo-chart-version Solo testing chart version [string] [default: "0.56.0"]
--debug-node-alias Enable default jvm debug port (5005) for the given node id [string]
--load-balancer Enable load balancer for network node proxies [boolean] [default: false]
--log4j2-xml log4j2.xml file for node [string] [default: "templates/log4j2.xml"]
--pvcs Enable persistent volume claims to store data outside the pod, required for consensus node add [boolean] [default: false]
--profile-file Resource profile definition (e.g. custom-spec.yaml) [string] [default: "profiles/custom-spec.yaml"]
--profile Resource profile (local | tiny | small | medium | large) [string] [default: "local"]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
--settings-txt settings.txt file for node [string] [default: "templates/settings.txt"]
-f, --values-file Comma separated chart values file paths for each cluster (e.g. values.yaml,cluster-1=./a/b/values1.yaml,cluster-2=./a/b/values2.yaml) [string]
-i, --node-aliases Comma separated node aliases (empty means all nodes) [string]
--grpc-tls-cert TLS Certificate path for the gRPC (e.g. "node1=/Users/username/node1-grpc.cert" with multiple nodes comma separated) [string]
--grpc-web-tls-cert TLS Certificate path for gRPC Web (e.g. "node1=/Users/username/node1-grpc-web.cert" with multiple nodes comma separated) [string]
--grpc-tls-key TLS Certificate key path for the gRPC (e.g. "node1=/Users/username/node1-grpc.key" with multiple nodes comma seperated) [string]
--grpc-web-tls-key TLC Certificate key path for gRPC Web (e.g. "node1=/Users/username/node1-grpc-web.key" with multiple nodes comma seperated) [string]
--haproxy-ips IP mapping where key = value is node alias and static ip for haproxy, (e.g.: --haproxy-ips node1=127.0.0.1,node2=127.0.0.1) [string]
--envoy-ips IP mapping where key = value is node alias and static ip for envoy proxy, (e.g.: --envoy-ips node1=127.0.0.1,node2=127.0.0.1) [string]
--storage-type storage type for saving stream files, available options are minio_only, aws_only, gcs_only, aws_and_gcs [default: "minio_only"]
--gcs-write-access-key gcs storage access key for write access [string]
--gcs-write-secrets gcs storage secret key for write access [string]
--gcs-endpoint gcs storage endpoint URL [string]
--gcs-bucket name of gcs storage bucket [string]
--gcs-bucket-prefix path prefix of google storage bucket [string]
--aws-write-access-key aws storage access key for write access [string]
--aws-write-secrets aws storage secret key for write access [string]
--aws-endpoint aws storage endpoint URL [string]
--aws-bucket name of aws storage bucket [string]
--aws-bucket-region name of aws bucket region [string]
--aws-bucket-prefix path prefix of aws storage bucket [string]
--backup-bucket name of bucket for backing up state files [string]
--backup-write-access-key backup storage access key for write access [string]
--backup-write-secrets backup storage secret key for write access [string]
--backup-endpoint backup storage endpoint URL [string]
--backup-region backup storage region [string] [default: "us-central1"]
--backup-provider backup storage service provider, GCS or AWS [string] [default: "GCS"]
--domain-names Custom domain names for consensus nodes mapping for the(e.g. node0=domain.name where key is node alias and value is domain name)with multiple nodes comma seperated [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus network destroy
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus network destroy --help
consensus network destroy
Removes all consensus network components from the deployment.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--delete-pvcs Delete the persistent volume claims. If both --delete-pvcs and --delete-secrets are set to true, the namespace will be deleted. [boolean] [default: false]
--delete-secrets Delete the network secrets. If both --delete-pvcs and --delete-secrets are set to true, the namespace will be deleted. [boolean] [default: false]
--enable-timeout enable time out for running a command [boolean] [default: false]
--force Force actions even if those can be skipped [boolean] [default: false]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus network freeze
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus network freeze --help
consensus network freeze
Initiates a network freeze for scheduled maintenance or upgrades
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus network upgrade
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus network upgrade --help
consensus network upgrade
Upgrades the software version running on all consensus nodes.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--upgrade-version Version to be used for the upgrade [string]
--app Testing app name [string] [default: "HederaNode.jar"]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--debug-node-alias Enable default jvm debug port (5005) for the given node id [string]
-i, --node-aliases Comma separated node aliases (empty means all nodes) [string]
--solo-chart-version Solo testing chart version [string] [default: "0.56.0"]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--local-build-path path of hedera local repo [string]
--force Force actions even if those can be skipped [boolean] [default: false]
--upgrade-zip-file A zipped file used for network upgrade [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus node
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus node --help
consensus node
List, create, manage, or destroy consensus node instances. Operates on a single consensus node instance at a time.
Commands:
consensus node setup Setup node with a specific version of Hedera platform
consensus node start Start a node
consensus node stop Stop a node
consensus node restart Restart all nodes of the network
consensus node refresh Reset and restart a node
consensus node add Adds a node with a specific version of Hedera platform
consensus node update Update a node with a specific version of Hedera platform
consensus node destroy Delete a node with a specific version of Hedera platform
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus node setup
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus node setup --help
consensus node setup
Setup node with a specific version of Hedera platform
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
--app Testing app name [string] [default: "HederaNode.jar"]
--app-config json config file of testing app [string]
-i, --node-aliases Comma separated node aliases (empty means all nodes) [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--local-build-path path of hedera local repo [string]
--admin-public-keys Comma separated list of DER encoded ED25519 public keys and must match the order of the node aliases [string]
--domain-names Custom domain names for consensus nodes mapping for the(e.g. node0=domain.name where key is node alias and value is domain name)with multiple nodes comma seperated [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus node start
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus node start --help
consensus node start
Start a node
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--app Testing app name [string] [default: "HederaNode.jar"]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-i, --node-aliases Comma separated node aliases (empty means all nodes) [string]
--debug-node-alias Enable default jvm debug port (5005) for the given node id [string]
--state-file A zipped state file to be used for the network [string]
--stake-amounts The amount to be staked in the same order you list the node aliases with multiple node staked values comma seperated [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus node stop
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus node stop --help
consensus node stop
Stop a node
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-i, --node-aliases Comma separated node aliases (empty means all nodes) [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus node restart
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus node restart --help
consensus node restart
Restart all nodes of the network
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus node refresh
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus node refresh --help
consensus node refresh
Reset and restart a node
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--app Testing app name [string] [default: "HederaNode.jar"]
--local-build-path path of hedera local repo [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-i, --node-aliases Comma separated node aliases (empty means all nodes) [string]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--domain-names Custom domain names for consensus nodes mapping for the(e.g. node0=domain.name where key is node alias and value is domain name)with multiple nodes comma seperated [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus node add
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus node add --help
consensus node add
Adds a node with a specific version of Hedera platform
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
--app Testing app name [string] [default: "HederaNode.jar"]
-l, --ledger-id Ledger ID (a.k.a. Chain ID) [string] [default: "298"]
--debug-node-alias Enable default jvm debug port (5005) for the given node id [string]
--solo-chart-version Solo testing chart version [string] [default: "0.56.0"]
--pvcs Enable persistent volume claims to store data outside the pod, required for consensus node add [boolean] [default: false]
--grpc-tls-cert TLS Certificate path for the gRPC (e.g. "node1=/Users/username/node1-grpc.cert" with multiple nodes comma separated) [string]
--grpc-web-tls-cert TLS Certificate path for gRPC Web (e.g. "node1=/Users/username/node1-grpc-web.cert" with multiple nodes comma separated) [string]
--grpc-tls-key TLS Certificate key path for the gRPC (e.g. "node1=/Users/username/node1-grpc.key" with multiple nodes comma seperated) [string]
--grpc-web-tls-key TLC Certificate key path for gRPC Web (e.g. "node1=/Users/username/node1-grpc-web.key" with multiple nodes comma seperated) [string]
--gossip-endpoints Comma separated gossip endpoints of the node(e.g. first one is internal, second one is external) [string]
--grpc-endpoints Comma separated gRPC endpoints of the node (at most 8) [string]
--force Force actions even if those can be skipped [boolean] [default: false]
--local-build-path path of hedera local repo [string]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--domain-names Custom domain names for consensus nodes mapping for the(e.g. node0=domain.name where key is node alias and value is domain name)with multiple nodes comma seperated [string]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--endpoint-type Endpoint type (IP or FQDN) [string] [default: "FQDN"]
--gossip-keys Generate gossip keys for nodes [boolean] [default: false]
--tls-keys Generate gRPC TLS keys for nodes [boolean] [default: false]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
--admin-key Admin key [string] [default: "302e020100300506032b65700422042091132178e72057a1d7528025956fe39b0b847f200ab59b2fdd367017f3087137"]
--haproxy-ips IP mapping where key = value is node alias and static ip for haproxy, (e.g.: --haproxy-ips node1=127.0.0.1,node2=127.0.0.1) [string]
--envoy-ips IP mapping where key = value is node alias and static ip for envoy proxy, (e.g.: --envoy-ips node1=127.0.0.1,node2=127.0.0.1) [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus node update
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus node update --help
consensus node update
Update a node with a specific version of Hedera platform
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--app Testing app name [string] [default: "HederaNode.jar"]
--local-build-path path of hedera local repo [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-i, --node-aliases Comma separated node aliases (empty means all nodes) [string]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--domain-names Custom domain names for consensus nodes mapping for the(e.g. node0=domain.name where key is node alias and value is domain name)with multiple nodes comma seperated [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus node destroy
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus node destroy --help
consensus node destroy
Delete a node with a specific version of Hedera platform
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--node-alias Node alias (e.g. node99) [string]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--app Testing app name [string] [default: "HederaNode.jar"]
-l, --ledger-id Ledger ID (a.k.a. Chain ID) [string] [default: "298"]
--debug-node-alias Enable default jvm debug port (5005) for the given node id [string]
--endpoint-type Endpoint type (IP or FQDN) [string] [default: "FQDN"]
--solo-chart-version Solo testing chart version [string] [default: "0.56.0"]
--force Force actions even if those can be skipped [boolean] [default: false]
--local-build-path path of hedera local repo [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
--domain-names Custom domain names for consensus nodes mapping for the(e.g. node0=domain.name where key is node alias and value is domain name)with multiple nodes comma seperated [string]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus state
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus state --help
consensus state
List, download, and upload consensus node state backups to/from individual consensus node instances.
Commands:
consensus state download Downloads a signed state from consensus node/nodes.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus state download
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus state download --help
consensus state download
Downloads a signed state from consensus node/nodes.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-i, --node-aliases Comma separated node aliases (empty means all nodes) [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus diagnostics
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus diagnostics --help
consensus diagnostics
Capture diagnostic information such as logs, signed states, and ledger/network/node configurations.
Commands:
consensus diagnostics config Collects configuration files from consensus nodes.
consensus diagnostics all Captures logs, configs, and diagnostic artifacts from all consensus nodes.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus diagnostics config
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus diagnostics config --help
consensus diagnostics config
Collects configuration files from consensus nodes.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus diagnostics all
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus diagnostics all --help
consensus diagnostics all
Captures logs, configs, and diagnostic artifacts from all consensus nodes.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-node-add
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-node-add --help
consensus dev-node-add
Dev operations for adding consensus nodes.
Commands:
consensus dev-node-add prepare Prepares the addition of a node with a specific version of Hedera platform
consensus dev-node-add submit-transactions Submits NodeCreateTransaction and Upgrade transactions to the network nodes
consensus dev-node-add execute Executes the addition of a previously prepared node
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-node-add prepare
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-node-add prepare --help
consensus dev-node-add prepare
Prepares the addition of a node with a specific version of Hedera platform
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
--output-dir Path to the directory where the command context will be saved to [string]
--app Testing app name [string] [default: "HederaNode.jar"]
-l, --ledger-id Ledger ID (a.k.a. Chain ID) [string] [default: "298"]
--debug-node-alias Enable default jvm debug port (5005) for the given node id [string]
--solo-chart-version Solo testing chart version [string] [default: "0.56.0"]
--pvcs Enable persistent volume claims to store data outside the pod, required for consensus node add [boolean] [default: false]
--grpc-tls-cert TLS Certificate path for the gRPC (e.g. "node1=/Users/username/node1-grpc.cert" with multiple nodes comma separated) [string]
--grpc-web-tls-cert TLS Certificate path for gRPC Web (e.g. "node1=/Users/username/node1-grpc-web.cert" with multiple nodes comma separated) [string]
--grpc-tls-key TLS Certificate key path for the gRPC (e.g. "node1=/Users/username/node1-grpc.key" with multiple nodes comma seperated) [string]
--grpc-web-tls-key TLC Certificate key path for gRPC Web (e.g. "node1=/Users/username/node1-grpc-web.key" with multiple nodes comma seperated) [string]
--gossip-endpoints Comma separated gossip endpoints of the node(e.g. first one is internal, second one is external) [string]
--grpc-endpoints Comma separated gRPC endpoints of the node (at most 8) [string]
--force Force actions even if those can be skipped [boolean] [default: false]
--local-build-path path of hedera local repo [string]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--domain-names Custom domain names for consensus nodes mapping for the(e.g. node0=domain.name where key is node alias and value is domain name)with multiple nodes comma seperated [string]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--endpoint-type Endpoint type (IP or FQDN) [string] [default: "FQDN"]
--gossip-keys Generate gossip keys for nodes [boolean] [default: false]
--tls-keys Generate gRPC TLS keys for nodes [boolean] [default: false]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
--admin-key Admin key [string] [default: "302e020100300506032b65700422042091132178e72057a1d7528025956fe39b0b847f200ab59b2fdd367017f3087137"]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-node-add submit-transactions
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-node-add submit-transactions --help
consensus dev-node-add submit-transactions
Submits NodeCreateTransaction and Upgrade transactions to the network nodes
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
--input-dir Path to the directory where the command context will be loaded from [string]
--app Testing app name [string] [default: "HederaNode.jar"]
-l, --ledger-id Ledger ID (a.k.a. Chain ID) [string] [default: "298"]
--debug-node-alias Enable default jvm debug port (5005) for the given node id [string]
--solo-chart-version Solo testing chart version [string] [default: "0.56.0"]
--pvcs Enable persistent volume claims to store data outside the pod, required for consensus node add [boolean] [default: false]
--grpc-tls-cert TLS Certificate path for the gRPC (e.g. "node1=/Users/username/node1-grpc.cert" with multiple nodes comma separated) [string]
--grpc-web-tls-cert TLS Certificate path for gRPC Web (e.g. "node1=/Users/username/node1-grpc-web.cert" with multiple nodes comma separated) [string]
--grpc-tls-key TLS Certificate key path for the gRPC (e.g. "node1=/Users/username/node1-grpc.key" with multiple nodes comma seperated) [string]
--grpc-web-tls-key TLC Certificate key path for gRPC Web (e.g. "node1=/Users/username/node1-grpc-web.key" with multiple nodes comma seperated) [string]
--gossip-endpoints Comma separated gossip endpoints of the node(e.g. first one is internal, second one is external) [string]
--grpc-endpoints Comma separated gRPC endpoints of the node (at most 8) [string]
--force Force actions even if those can be skipped [boolean] [default: false]
--local-build-path path of hedera local repo [string]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--domain-names Custom domain names for consensus nodes mapping for the(e.g. node0=domain.name where key is node alias and value is domain name)with multiple nodes comma seperated [string]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--endpoint-type Endpoint type (IP or FQDN) [string] [default: "FQDN"]
--gossip-keys Generate gossip keys for nodes [boolean] [default: false]
--tls-keys Generate gRPC TLS keys for nodes [boolean] [default: false]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-node-add execute
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-node-add execute --help
consensus dev-node-add execute
Executes the addition of a previously prepared node
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
--input-dir Path to the directory where the command context will be loaded from [string]
--app Testing app name [string] [default: "HederaNode.jar"]
-l, --ledger-id Ledger ID (a.k.a. Chain ID) [string] [default: "298"]
--debug-node-alias Enable default jvm debug port (5005) for the given node id [string]
--solo-chart-version Solo testing chart version [string] [default: "0.56.0"]
--pvcs Enable persistent volume claims to store data outside the pod, required for consensus node add [boolean] [default: false]
--grpc-tls-cert TLS Certificate path for the gRPC (e.g. "node1=/Users/username/node1-grpc.cert" with multiple nodes comma separated) [string]
--grpc-web-tls-cert TLS Certificate path for gRPC Web (e.g. "node1=/Users/username/node1-grpc-web.cert" with multiple nodes comma separated) [string]
--grpc-tls-key TLS Certificate key path for the gRPC (e.g. "node1=/Users/username/node1-grpc.key" with multiple nodes comma seperated) [string]
--grpc-web-tls-key TLC Certificate key path for gRPC Web (e.g. "node1=/Users/username/node1-grpc-web.key" with multiple nodes comma seperated) [string]
--gossip-endpoints Comma separated gossip endpoints of the node(e.g. first one is internal, second one is external) [string]
--grpc-endpoints Comma separated gRPC endpoints of the node (at most 8) [string]
--force Force actions even if those can be skipped [boolean] [default: false]
--local-build-path path of hedera local repo [string]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--domain-names Custom domain names for consensus nodes mapping for the(e.g. node0=domain.name where key is node alias and value is domain name)with multiple nodes comma seperated [string]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--endpoint-type Endpoint type (IP or FQDN) [string] [default: "FQDN"]
--gossip-keys Generate gossip keys for nodes [boolean] [default: false]
--tls-keys Generate gRPC TLS keys for nodes [boolean] [default: false]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
--haproxy-ips IP mapping where key = value is node alias and static ip for haproxy, (e.g.: --haproxy-ips node1=127.0.0.1,node2=127.0.0.1) [string]
--envoy-ips IP mapping where key = value is node alias and static ip for envoy proxy, (e.g.: --envoy-ips node1=127.0.0.1,node2=127.0.0.1) [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-node-update
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-node-update --help
consensus dev-node-update
Dev operations for updating consensus nodes
Commands:
consensus dev-node-update prepare Prepare the deployment to update a node with a specific version of Hedera platform
consensus dev-node-update submit-transactions Submit transactions for updating a node with a specific version of Hedera platform
consensus dev-node-update execute Executes the updating of a node with a specific version of Hedera platform
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-node-update prepare
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-node-update prepare --help
consensus dev-node-update prepare
Prepare the deployment to update a node with a specific version of Hedera platform
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--output-dir Path to the directory where the command context will be saved to [string]
--node-alias Node alias (e.g. node99) [string]
--app Testing app name [string] [default: "HederaNode.jar"]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--debug-node-alias Enable default jvm debug port (5005) for the given node id [string]
--endpoint-type Endpoint type (IP or FQDN) [string] [default: "FQDN"]
--solo-chart-version Solo testing chart version [string] [default: "0.56.0"]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--local-build-path path of hedera local repo [string]
--force Force actions even if those can be skipped [boolean] [default: false]
--gossip-endpoints Comma separated gossip endpoints of the node(e.g. first one is internal, second one is external) [string]
--grpc-endpoints Comma separated gRPC endpoints of the node (at most 8) [string]
--domain-names Custom domain names for consensus nodes mapping for the(e.g. node0=domain.name where key is node alias and value is domain name)with multiple nodes comma seperated [string]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
--new-admin-key new admin key for the Hedera account [string]
--new-account-number new account number for node update transaction [string]
--tls-public-key path and file name of the public TLS key to be used [string]
--gossip-private-key path and file name of the private key for signing gossip in PEM key format to be used [string]
--gossip-public-key path and file name of the public key for signing gossip in PEM key format to be used [string]
--tls-private-key path and file name of the private TLS key to be used [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-node-update submit-transactions
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-node-update submit-transactions --help
consensus dev-node-update submit-transactions
Submit transactions for updating a node with a specific version of Hedera platform
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--input-dir Path to the directory where the command context will be loaded from [string]
--app Testing app name [string] [default: "HederaNode.jar"]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--debug-node-alias Enable default jvm debug port (5005) for the given node id [string]
--endpoint-type Endpoint type (IP or FQDN) [string] [default: "FQDN"]
--solo-chart-version Solo testing chart version [string] [default: "0.56.0"]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--local-build-path path of hedera local repo [string]
--force Force actions even if those can be skipped [boolean] [default: false]
--gossip-endpoints Comma separated gossip endpoints of the node(e.g. first one is internal, second one is external) [string]
--grpc-endpoints Comma separated gRPC endpoints of the node (at most 8) [string]
--domain-names Custom domain names for consensus nodes mapping for the(e.g. node0=domain.name where key is node alias and value is domain name)with multiple nodes comma seperated [string]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-node-update execute
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-node-update execute --help
consensus dev-node-update execute
Executes the updating of a node with a specific version of Hedera platform
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--input-dir Path to the directory where the command context will be loaded from [string]
--app Testing app name [string] [default: "HederaNode.jar"]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--debug-node-alias Enable default jvm debug port (5005) for the given node id [string]
--endpoint-type Endpoint type (IP or FQDN) [string] [default: "FQDN"]
--solo-chart-version Solo testing chart version [string] [default: "0.56.0"]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--local-build-path path of hedera local repo [string]
--force Force actions even if those can be skipped [boolean] [default: false]
--gossip-endpoints Comma separated gossip endpoints of the node(e.g. first one is internal, second one is external) [string]
--grpc-endpoints Comma separated gRPC endpoints of the node (at most 8) [string]
--domain-names Custom domain names for consensus nodes mapping for the(e.g. node0=domain.name where key is node alias and value is domain name)with multiple nodes comma seperated [string]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-node-upgrade
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-node-upgrade --help
consensus dev-node-upgrade
Dev operations for upgrading consensus nodes
Commands:
consensus dev-node-upgrade prepare Prepare for upgrading network
consensus dev-node-upgrade submit-transactions Submit transactions for upgrading network
consensus dev-node-upgrade execute Executes the upgrading the network
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-node-upgrade prepare
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-node-upgrade prepare --help
consensus dev-node-upgrade prepare
Prepare for upgrading network
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-node-upgrade submit-transactions
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-node-upgrade submit-transactions --help
consensus dev-node-upgrade submit-transactions
Submit transactions for upgrading network
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--input-dir Path to the directory where the command context will be loaded from [string]
--app Testing app name [string] [default: "HederaNode.jar"]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--debug-node-alias Enable default jvm debug port (5005) for the given node id [string]
-i, --node-aliases Comma separated node aliases (empty means all nodes) [string]
--solo-chart-version Solo testing chart version [string] [default: "0.56.0"]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--local-build-path path of hedera local repo [string]
--force Force actions even if those can be skipped [boolean] [default: false]
--upgrade-zip-file A zipped file used for network upgrade [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-node-upgrade execute
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-node-upgrade execute --help
consensus dev-node-upgrade execute
Executes the upgrading the network
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--input-dir Path to the directory where the command context will be loaded from [string]
--app Testing app name [string] [default: "HederaNode.jar"]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--debug-node-alias Enable default jvm debug port (5005) for the given node id [string]
-i, --node-aliases Comma separated node aliases (empty means all nodes) [string]
--solo-chart-version Solo testing chart version [string] [default: "0.56.0"]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--local-build-path path of hedera local repo [string]
--force Force actions even if those can be skipped [boolean] [default: false]
--upgrade-zip-file A zipped file used for network upgrade [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-node-delete
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-node-delete --help
consensus dev-node-delete
Dev operations for delete consensus nodes
Commands:
consensus dev-node-delete prepare Prepares the deletion of a node with a specific version of Hedera platform
consensus dev-node-delete submit-transactions Submits transactions to the network nodes for deleting a node
consensus dev-node-delete execute Executes the deletion of a previously prepared node
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-node-delete prepare
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-node-delete prepare --help
consensus dev-node-delete prepare
Prepares the deletion of a node with a specific version of Hedera platform
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--node-alias Node alias (e.g. node99) [string]
--output-dir Path to the directory where the command context will be saved to [string]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--app Testing app name [string] [default: "HederaNode.jar"]
-l, --ledger-id Ledger ID (a.k.a. Chain ID) [string] [default: "298"]
--debug-node-alias Enable default jvm debug port (5005) for the given node id [string]
--endpoint-type Endpoint type (IP or FQDN) [string] [default: "FQDN"]
--solo-chart-version Solo testing chart version [string] [default: "0.56.0"]
--force Force actions even if those can be skipped [boolean] [default: false]
--local-build-path path of hedera local repo [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
--domain-names Custom domain names for consensus nodes mapping for the(e.g. node0=domain.name where key is node alias and value is domain name)with multiple nodes comma seperated [string]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-node-delete submit-transactions
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-node-delete submit-transactions --help
consensus dev-node-delete submit-transactions
Submits transactions to the network nodes for deleting a node
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--node-alias Node alias (e.g. node99) [string]
--input-dir Path to the directory where the command context will be loaded from [string]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--app Testing app name [string] [default: "HederaNode.jar"]
-l, --ledger-id Ledger ID (a.k.a. Chain ID) [string] [default: "298"]
--debug-node-alias Enable default jvm debug port (5005) for the given node id [string]
--endpoint-type Endpoint type (IP or FQDN) [string] [default: "FQDN"]
--solo-chart-version Solo testing chart version [string] [default: "0.56.0"]
--force Force actions even if those can be skipped [boolean] [default: false]
--local-build-path path of hedera local repo [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
--domain-names Custom domain names for consensus nodes mapping for the(e.g. node0=domain.name where key is node alias and value is domain name)with multiple nodes comma seperated [string]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-node-delete execute
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-node-delete execute --help
consensus dev-node-delete execute
Executes the deletion of a previously prepared node
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--node-alias Node alias (e.g. node99) [string]
--input-dir Path to the directory where the command context will be loaded from [string]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--app Testing app name [string] [default: "HederaNode.jar"]
-l, --ledger-id Ledger ID (a.k.a. Chain ID) [string] [default: "298"]
--debug-node-alias Enable default jvm debug port (5005) for the given node id [string]
--endpoint-type Endpoint type (IP or FQDN) [string] [default: "FQDN"]
--solo-chart-version Solo testing chart version [string] [default: "0.56.0"]
--force Force actions even if those can be skipped [boolean] [default: false]
--local-build-path path of hedera local repo [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
--domain-names Custom domain names for consensus nodes mapping for the(e.g. node0=domain.name where key is node alias and value is domain name)with multiple nodes comma seperated [string]
-t, --release-tag Release tag to be used (e.g. v0.63.9) [string] [default: "v0.63.9"]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-freeze
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-freeze --help
consensus dev-freeze
Dev operations for freezing consensus nodes
Commands:
consensus dev-freeze prepare-upgrade Prepare the network for a Freeze Upgrade operation
consensus dev-freeze freeze-upgrade Performs a Freeze Upgrade operation with on the network after it has been prepared with prepare-upgrade
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-freeze prepare-upgrade
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-freeze prepare-upgrade --help
consensus dev-freeze prepare-upgrade
Prepare the network for a Freeze Upgrade operation
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--skip-node-alias The node alias to skip, because of a NodeUpdateTransaction or it is down (e.g. node99) [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
consensus dev-freeze freeze-upgrade
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts consensus dev-freeze freeze-upgrade --help
consensus dev-freeze freeze-upgrade
Performs a Freeze Upgrade operation with on the network after it has been prepared with prepare-upgrade
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--skip-node-alias The node alias to skip, because of a NodeUpdateTransaction or it is down (e.g. node99) [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
deployment
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts deployment --help
deployment
Create, modify, and delete deployment configurations. Deployments are required for most of the other commands.
Commands:
deployment cluster View and manage Solo cluster references used by a deployment.
deployment config List, view, create, delete, and import deployments. These commands affect the local configuration only.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
deployment cluster
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts deployment cluster --help
deployment cluster
View and manage Solo cluster references used by a deployment.
Commands:
deployment cluster attach Attaches a cluster reference to a deployment.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
deployment cluster attach
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts deployment cluster attach --help
deployment cluster attach
Attaches a cluster reference to a deployment.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--enable-cert-manager Pass the flag to enable cert manager [boolean] [default: false]
--num-consensus-nodes Used to specify desired number of consensus nodes for pre-genesis deployments [number]
--dns-base-domain Base domain for the DNS is the suffix used to construct the fully qualified domain name (FQDN) [string] [default: "cluster.local"]
--dns-consensus-node-pattern Pattern to construct the prefix for the fully qualified domain name (FQDN) for the consensus node, the suffix is provided by the --dns-base-domain option (ex. network-{nodeAlias}-svc.{namespace}.svc) [string] [default: "network-{nodeAlias}-svc.{namespace}.svc"]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
deployment config
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts deployment config --help
deployment config
List, view, create, delete, and import deployments. These commands affect the local configuration only.
Commands:
deployment config list Lists all local deployment configurations.
deployment config create Creates a new local deployment configuration.
deployment config delete Removes a local deployment configuration.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
deployment config list
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts deployment config list --help
deployment config list
Lists all local deployment configurations.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
deployment config create
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts deployment config create --help
deployment config create
Creates a new local deployment configuration.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-n, --namespace Namespace [string]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--realm Realm number. Requires network-node > v61.0 for non-zero values [number] [default: 0]
--shard Shard number. Requires network-node > v61.0 for non-zero values [number] [default: 0]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
deployment config delete
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts deployment config delete --help
deployment config delete
Removes a local deployment configuration.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
explorer
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts explorer --help
explorer
Explorer Node operations for creating, modifying, and destroying resources.These commands require the presence of an existing deployment.
Commands:
explorer node List, create, manage, or destroy explorer node instances. Operates on a single explorer node instance at a time.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
explorer node
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts explorer node --help
explorer node
List, create, manage, or destroy explorer node instances. Operates on a single explorer node instance at a time.
Commands:
explorer node add Adds and configures a new node instance.
explorer node destroy Deletes the specified node from the deployment.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
explorer node add
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts explorer node add --help
explorer node add
Adds and configures a new node instance.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
--enable-ingress enable ingress on the component/pod [boolean] [default: false]
--ingress-controller-value-file The value file to use for ingress controller, defaults to "" [string]
--enable-explorer-tls Enable Explorer TLS, defaults to false, requires certManager and certManagerCrds, which can be deployed through solo-cluster-setup chart or standalone [boolean] [default: false]
--explorer-tls-host-name The host name to use for the Explorer TLS, defaults to "explorer.solo.local" [string] [default: "explorer.solo.local"]
--explorer-static-ip The static IP address to use for the Explorer load balancer, defaults to "" [string]
--explorer-version Explorer chart version [string] [default: "25.1.1"]
--mirror-namespace Namespace to use for the Mirror Node deployment, a new one will be created if it does not exist [string]
-n, --namespace Namespace [string]
--profile-file Resource profile definition (e.g. custom-spec.yaml) [string] [default: "profiles/custom-spec.yaml"]
--profile Resource profile (local | tiny | small | medium | large) [string] [default: "local"]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--solo-chart-version Solo testing chart version [string] [default: "0.56.0"]
--tls-cluster-issuer-type The TLS cluster issuer type to use for hedera explorer, defaults to "self-signed", the available options are: "acme-staging", "acme-prod", or "self-signed" [string] [default: "self-signed"]
-f, --values-file Comma separated chart values file [string]
-s, --cluster-setup-namespace Cluster Setup Namespace [string] [default: "solo-setup"]
--domain-name Custom domain name [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
explorer node destroy
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts explorer node destroy --help
explorer node destroy
Deletes the specified node from the deployment.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
--force Force actions even if those can be skipped [boolean] [default: false]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
keys
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts keys --help
keys
Consensus key generation operations
Commands:
keys consensus Generate unique cryptographic keys (gossip or grpc TLS keys) for the Consensus Node instances.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
keys consensus
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts keys consensus --help
keys consensus
Generate unique cryptographic keys (gossip or grpc TLS keys) for the Consensus Node instances.
Commands:
keys consensus generate Generates TLS keys required for consensus node communication.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
keys consensus generate
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts keys consensus generate --help
keys consensus generate
Generates TLS keys required for consensus node communication.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--gossip-keys Generate gossip keys for nodes [boolean] [default: false]
--tls-keys Generate gRPC TLS keys for nodes [boolean] [default: false]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-i, --node-aliases Comma separated node aliases (empty means all nodes) [string]
-n, --namespace Namespace [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
ledger
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts ledger --help
ledger
System, Account, and Crypto ledger-based management operations. These commands require an operational set of consensus nodes and may require an operational mirror node.
Commands:
ledger system Perform a full ledger initialization on a new deployment, rekey privileged/system accounts, or setup network staking parameters.
ledger account View, list, create, update, delete, and import ledger accounts.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
ledger system
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts ledger system --help
ledger system
Perform a full ledger initialization on a new deployment, rekey privileged/system accounts, or setup network staking parameters.
Commands:
ledger system init Rekeys system accounts and stake consensus nodes.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
ledger system init
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts ledger system init --help
ledger system init
Rekeys system accounts and stake consensus nodes.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-i, --node-aliases Comma separated node aliases (empty means all nodes) [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
ledger account
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts ledger account --help
ledger account
View, list, create, update, delete, and import ledger accounts.
Commands:
ledger account update Updates an existing ledger account.
ledger account create Creates a new ledger account.
ledger account info Gets the account info including the current amount of HBAR
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
ledger account update
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts ledger account update --help
ledger account update
Updates an existing ledger account.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
--account-id The Hedera account id, e.g.: 0.0.1001 [string]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--hbar-amount Amount of HBAR to add [number] [default: 100]
--ecdsa-private-key ECDSA private key for the Hedera account [string]
--ed25519-private-key ED25519 private key for the Hedera account [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
ledger account create
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts ledger account create --help
ledger account create
Creates a new ledger account.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--hbar-amount Amount of HBAR to add [number] [default: 100]
--create-amount Amount of new account to create [number] [default: 1]
--ecdsa-private-key ECDSA private key for the Hedera account [string]
--private-key Show private key information [boolean] [default: false]
--ed25519-private-key ED25519 private key for the Hedera account [string]
--generate-ecdsa-key Generate ECDSA private key for the Hedera account [boolean] [default: false]
--set-alias Sets the alias for the Hedera account when it is created, requires --ecdsa-private-key [boolean] [default: false]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
ledger account info
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts ledger account info --help
ledger account info
Gets the account info including the current amount of HBAR
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
--account-id The Hedera account id, e.g.: 0.0.1001 [string]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--private-key Show private key information [boolean] [default: false]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
mirror
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts mirror --help
mirror
Mirror Node operations for creating, modifying, and destroying resources. These commands require the presence of an existing deployment.
Commands:
mirror node List, create, manage, or destroy mirror node instances. Operates on a single mirror node instance at a time.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
mirror node
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts mirror node --help
mirror node
List, create, manage, or destroy mirror node instances. Operates on a single mirror node instance at a time.
Commands:
mirror node add Adds and configures a new node instance.
mirror node destroy Deletes the specified node from the deployment.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
mirror node add
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts mirror node add --help
mirror node add
Adds and configures a new node instance.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
--enable-ingress enable ingress on the component/pod [boolean] [default: false]
--ingress-controller-value-file The value file to use for ingress controller, defaults to "" [string]
--mirror-static-ip static IP address for the mirror node [string]
--profile-file Resource profile definition (e.g. custom-spec.yaml) [string] [default: "profiles/custom-spec.yaml"]
--profile Resource profile (local | tiny | small | medium | large) [string] [default: "local"]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-f, --values-file Comma separated chart values file [string]
--mirror-node-version Mirror node chart version [string] [default: "v0.136.0"]
--pinger Enable Pinger service in the Mirror node monitor [boolean] [default: false]
--use-external-database Set to true if you have an external database to use instead of the database that the Mirror Node Helm chart supplies [boolean] [default: false]
--operator-id Operator ID [string]
--operator-key Operator Key [string]
--storage-type storage type for saving stream files, available options are minio_only, aws_only, gcs_only, aws_and_gcs [default: "minio_only"]
--storage-read-access-key storage read access key for mirror node importer [string]
--storage-read-secrets storage read-secret key for mirror node importer [string]
--storage-endpoint storage endpoint URL for mirror node importer [string]
--storage-bucket name of storage bucket for mirror node importer [string]
--storage-bucket-prefix path prefix of storage bucket mirror node importer [string]
--storage-bucket-region region of storage bucket mirror node importer [string]
--external-database-host Use to provide the external database host if the '--use-external-database' is passed [string]
--external-database-owner-username Use to provide the external database owner's username if the '--use-external-database' is passed [string]
--external-database-owner-password Use to provide the external database owner's password if the '--use-external-database' is passed [string]
--external-database-read-username Use to provide the external database readonly user's username if the '--use-external-database' is passed [string]
--external-database-read-password Use to provide the external database readonly user's password if the '--use-external-database' is passed [string]
--domain-name Custom domain name [string]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
mirror node destroy
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts mirror node destroy --help
mirror node destroy
Deletes the specified node from the deployment.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
--force Force actions even if those can be skipped [boolean] [default: false]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
relay
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts relay --help
relay
RPC Relay Node operations for creating, modifying, and destroying resources. These commands require the presence of an existing deployment.
Commands:
relay node List, create, manage, or destroy relay node instances. Operates on a single relay node instance at a time.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
relay node
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts relay node --help
relay node
List, create, manage, or destroy relay node instances. Operates on a single relay node instance at a time.
Commands:
relay node add Adds and configures a new node instance.
relay node destroy Deletes the specified node from the deployment.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
relay node add
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts relay node add --help
relay node add
Adds and configures a new node instance.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-l, --ledger-id Ledger ID (a.k.a. Chain ID) [string] [default: "298"]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
-i, --node-aliases Comma separated node aliases (empty means all nodes) [string]
--operator-id Operator ID [string]
--operator-key Operator Key [string]
--profile-file Resource profile definition (e.g. custom-spec.yaml) [string] [default: "profiles/custom-spec.yaml"]
--profile Resource profile (local | tiny | small | medium | large) [string] [default: "local"]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--relay-release Relay release tag to be used (e.g. v0.48.0) [string] [default: "0.70.0"]
--replica-count Replica count [number] [default: 1]
-f, --values-file Comma separated chart values file [string]
--domain-name Custom domain name [string]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
relay node destroy
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts relay node destroy --help
relay node destroy
Deletes the specified node from the deployment.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
--chart-dir Local chart directory path (e.g. ~/solo-charts/charts [string]
-i, --node-aliases Comma separated node aliases (empty means all nodes) [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
quick-start
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts quick-start --help
quick-start
Quick start commands for new and returning users who need a preset environment type. These commands use reasonable defaults to provide a single command out of box experience.
Commands:
quick-start single Creates a uniquely named deployment with a single consensus node, mirror node, block node, relay node, and explorer node.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
quick-start single
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts quick-start single --help
quick-start single
Creates a uniquely named deployment with a single consensus node, mirror node, block node, relay node, and explorer node.
Commands:
quick-start single deploy Deploys all required components for the selected quick start configuration.
quick-start single destroy Removes the deployed resources for the selected quick start configuration.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
quick-start single deploy
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts quick-start single deploy --help
quick-start single deploy
Deploys all required components for the selected quick start configuration.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
-s, --cluster-setup-namespace Cluster Setup Namespace [string] [default: "solo-setup"]
--context The Kubernetes context name to be used [string]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-n, --namespace Namespace [string]
--num-consensus-nodes Used to specify desired number of consensus nodes for pre-genesis deployments [number]
--predefined-accounts Create predefined accounts on network creation [boolean] [default: true]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
quick-start single destroy
> @hashgraph/solo@0.43.0 solo-test
> tsx --no-deprecation --no-warnings solo.ts quick-start single destroy --help
quick-start single destroy
Removes the deployed resources for the selected quick start configuration.
Options:
--dev Enable developer mode [boolean] [default: false]
--force-port-forward Force port forward to access the network services [boolean] [default: true]
--cache-dir Local cache directory [string] [default: "/home/runner/.solo/cache"]
-c, --cluster-ref The cluster reference that will be used for referencing the Kubernetes cluster and stored in the local and remote configuration for the deployment. For commands that take multiple clusters they can be separated by commas. [string]
--context The Kubernetes context name to be used [string]
-d, --deployment The name the user will reference locally to link to a deployment [string]
-n, --namespace Namespace [string]
-q, --quiet-mode Quiet mode, do not prompt for confirmation [boolean] [default: false]
--force Force actions even if those can be skipped [boolean] [default: false]
-h, --help Show help [boolean]
-v, --version Show version number [boolean]