Skip to main content

​
Most Used Commands

Create a new topic with admin and submit key set
Submit a message
Find messages between a range of 1 and 3

​
Full Command Reference

Create a new Hedera Consensus Service topic with optional memo and keys.
​
string
Define the name for this topic.
​
string
The memo for a topic.
​
string (repeatable)
Admin key(s) of the topic. Pass multiple times for multiple keys. Format: {accountId}:{privateKey}, private key in {ed25519|ecdsa}:private:{key} format, key reference, or account alias.
​
string (repeatable)
Submit key(s) of the topic. Pass multiple times for multiple keys. Format: {accountId}:{privateKey}, public/private key in {ed25519|ecdsa}:public|private:{key} format, key reference, or account alias.
​
int
Number of admin keys required to sign (M-of-N). Default: all keys must sign. Only applies when multiple --admin-key values are provided.
​
int
Number of submit keys required to sign (M-of-N). Default: all keys must sign. Only applies when multiple --submit-key values are provided.
​
string(local|local_encrypted)
Key manager to use: local or local_encrypted (defaults to config setting)
Import an existing topic into state. Provide the topic ID (for example 0.0.123456).
​
string
required
Topic ID to import (e.g., 0.0.123456)
​
string
Name or alias for the topic
List all topics stored in the state.
Submit a message to a Hedera Consensus Service topic
​
string
required
The topic ID or topic name.
​
string
required
Submit a message to the topic.
​
string (repeatable)
Key(s) to sign the message with. Pass multiple times for threshold topics. Can be {accountId}:{privateKey} pair, account private key in {ed25519|ecdsa}:private:{private-key} format, key reference, or account alias.
​
string(local|local_encrypted)
Key manager to use: local or local_encrypted (defaults to config setting)
Update a Hedera Consensus Service topic. Requires admin key for most updates. Pass null to clear memo, submit key, or auto-renew account.
​
string
required
Topic ID or alias to update
​
string
New memo for the topic. Pass null to clear.
​
string (repeatable)
New admin key(s). Pass multiple times for multiple keys. Cannot be cleared, only replaced.
​
string (repeatable)
New submit key(s). Pass null to clear (makes the topic public).
​
int
Number of admin keys required to sign (M-of-N). Only applies when multiple --admin-key values are provided.
​
int
Number of submit keys required to sign (M-of-N). Only applies when multiple --submit-key values are provided.
​
string(local|local_encrypted)
Key manager to use: local or local_encrypted (defaults to config setting)
​
string
Auto-renew account ID or alias. Pass null to clear.
​
number
Auto-renew period in seconds (min 2592000 / 30 days, max 8000000 / ~92 days)
​
string
Expiration time as ISO datetime string
Delete a Hedera topic on the network and remove it from local state, or remove from local state only with --state-only.
​
string
required
Topic name or topic ID
​
Remove only from local CLI state (no TopicDeleteTransaction on Hedera)
​
string (repeatable)
Admin credential(s) for signing TopicDeleteTransaction on Hedera. Required for network delete unless --state-only is used.
​
string(local|local_encrypted)
Key manager when resolving --admin-key (defaults to config)
Find messages in a topic by sequence number or filters
​
string
required
The topic ID or topic name to filter for.
​
int
Filter by sequence number greater than.
​
int
Filter by sequence number greater than or equal to.
​
int
Filter by sequence number less than.
​
int
Filter by sequence number less than or equal to.
​
int
Filter by sequence number equal to.