Account Plugin

Most Used Commands

Create a new account

hcli account create \
  --balance 1 \
  --name <account-name>

Check an account balance

hcli account balance --account myaccount

List all accounts

hcli account list

Full Command Reference

Account Create

Creates a new Hedera account.

-b, --balance · string · required

Initial HBAR balance. Default: display units. Add “t” for Tinybar units
--balance 10 —> 10 HBAR
--balance 100t —> 100 Tinybars

-a, --auto-associations · int

The maximum number of automatic association tokens allowed
Default value set to 0

-n, --name · string

Alias of the created account to be used

-k, --key-manager · string

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

-t, --key-type · string(ecdsa|ed25519)

Key type for the account. Default: ecdsa. Mutually exclusive with --key.

-K, --key · string

Existing key for the new account (ecdsa/ed25519 private or public key, key reference kr_xxx, or alias name). Mutually exclusive with --key-type.

Account Update

Update properties of an existing Hedera account on-chain.

-a, --account · string · required

Account ID or alias of the account to update

-K, --key · string

New key for the account (private/public key, key reference, or alias). Requires private key in KMS.

-k, --key-manager · string

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

-m, --memo · string

Account memo (max 100 characters). Pass null to clear.

--max-auto-associations · number

Max automatic token associations (-1 for unlimited, 0 to disable)

--staked-account-id · string

Account ID to stake to. Pass null to clear.

--staked-node-id · number

Node ID to stake to. Pass null to clear.

--decline-staking-reward · boolean

Decline staking reward

--auto-renew-period · number

Auto renew period in seconds

--receiver-signature-required · boolean

Require receiver signature for transfers

Account Import

Import an existing account into the CLI tool. Provide accountId:privateKey format.

-K, --key · string · required

Specify the private key in accountId:privateKey format (e.g., “0.0.123456:abc123...”)

-n, --name · string

Name of the account to be used

-k, --key-manager · string

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

Account Balance

Retrieve the balance for an account ID or name.

-a, --account · string · required

Account ID, alias or name of the account present in state

-H, --hbar-only

Show only HBAR balance

-t, --token · string

Show balance for specific token ID, specify token ID or name

-r, --raw

Display balances in raw units (tinybars for HBAR, base units for tokens)

Account List

List all accounts stored in the address book.

-p, --private

Include private keys reference ID in listing. This is not the actual private key!

Account View

View detailed information about an account.

-a, --account · string · required

View data for account ID or name of the account present in state.

Account Clear

Remove all account information from the address book.

Account Delete

Delete an account on Hedera and remove it from local state if present, or remove from local state only with --state-only. On-chain delete requires --transfer-id for the beneficiary account.

-a, --account · string · required

With --state-only: Hedera account ID or local alias. Otherwise: account key (ID, id:private key, key reference, alias with stored key, etc.)

-t, --transfer-id · string

Required when deleting on Hedera: account that receives remaining HBAR (Hedera ID or alias). Mutually exclusive with --state-only.

-s, --state-only

Remove the account only from local CLI state. Do not submit AccountDeleteTransaction. Mutually exclusive with --transfer-id.