Topic Plugin

Most Used Commands

Create a new topic with admin and submit key set

hcli topic create \
  --name marketing-updates \
  --memo "Weekly digest" \
  --admin-key alice \
  --submit-key bob

Submit a message

hcli topic submit-message \
  --topic 0.0.7473019 \
  --message '{"event":"mint","amount":10}'

Find messages between a range of 1 and 3

hcli topic find-message \
  --topic marketing-updates \
  --sequence-gt 1 \
  --sequence-lt 3

Full Command Reference

Topic Create

Create a new Hedera Consensus Service topic with optional memo and keys.

-n, --name · string

Define the name for this topic.

-m, --memo · string

The memo for a topic.

-a, --admin-key · 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.

-s, --submit-key · 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.

-A, --admin-key-threshold · 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.

-S, --submit-key-threshold · 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.

-k, --key-manager · string(local|local_encrypted)

Key manager to use: local or local_encrypted (defaults to config setting)

Topic Import

Import an existing topic into state. Provide the topic ID (for example 0.0.123456).

-t, --topic · string · required

Topic ID to import (e.g., 0.0.123456)

-n, --name · string

Name or alias for the topic

Topic List

List all topics stored in the state.

Topic Submit-Message

Submit a message to a Hedera Consensus Service topic

-t, --topic · string · required

The topic ID or topic name.

-m, --message · string · required

Submit a message to the topic.

-s, --signer · 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.

-k, --key-manager · string(local|local_encrypted)

Key manager to use: local or local_encrypted (defaults to config setting)

Topic Update

Update a Hedera Consensus Service topic. Requires admin key for most updates. Pass null to clear memo, submit key, or auto-renew account.

-t, --topic · string · required

Topic ID or alias to update

-m, --memo · string

New memo for the topic. Pass null to clear.

-a, --admin-key · string (repeatable)

New admin key(s). Pass multiple times for multiple keys. Cannot be cleared, only replaced.

-s, --submit-key · string (repeatable)

New submit key(s). Pass null to clear (makes the topic public).

-A, --admin-key-threshold · int

Number of admin keys required to sign (M-of-N). Only applies when multiple --admin-key values are provided.

-S, --submit-key-threshold · int

Number of submit keys required to sign (M-of-N). Only applies when multiple --submit-key values are provided.

-k, --key-manager · string(local|local_encrypted)

Key manager to use: local or local_encrypted (defaults to config setting)

-r, --auto-renew-account · string

Auto-renew account ID or alias. Pass null to clear.

-p, --auto-renew-period · number

Auto-renew period in seconds (min 2592000 / 30 days, max 8000000 / ~92 days)

-e, --expiration-time · string

Expiration time as ISO datetime string

Topic Delete

Delete a Hedera topic on the network and remove it from local state, or remove from local state only with --state-only.

-t, --topic · string · required

Topic name or topic ID

-s, --state-only

Remove only from local CLI state (no TopicDeleteTransaction on Hedera)

-a, --admin-key · string (repeatable)

Admin credential(s) for signing TopicDeleteTransaction on Hedera. Required for network delete unless --state-only is used.

-k, --key-manager · string(local|local_encrypted)

Key manager when resolving --admin-key (defaults to config)

Topic Find-Message

Find messages in a topic by sequence number or filters

-t, --topic · string · required

The topic ID or topic name to filter for.

-g, --sequence-gt · int

Filter by sequence number greater than.

-G, --sequence-gte · int

Filter by sequence number greater than or equal to.

-l, --sequence-lt · int

Filter by sequence number less than.

-L, --sequence-lte · int

Filter by sequence number less than or equal to.

-e, --sequence-eq · int

Filter by sequence number equal to.