hive-nectar CLI

hive-nectar is a convenient CLI utility that enables you to manage your wallet, transfer funds, check balances and more.

Using the Wallet

hive-nectar lets you leverage your BIP38 encrypted wallet to perform various actions on your accounts.

The first time you use hive-nectar, you will be prompted to enter a password. This password will be used to encrypt the hive-nectar wallet, which contains your private keys.

You can change the password via changewalletpassphrase command.

hive-nectar changewalletpassphrase

From this point on, every time an action requires your private keys, you will be prompted ot enter this password (from CLI as well as while using hive library).

To bypass password entry, you can set an environment variable UNLOCK.

UNLOCK=mysecretpassword hive-nectar transfer <recipient_name> 100 HIVE

Using a key json file

A key_file.json can be used to provide private keys to hive-nectar:

{
    "account_a": {"posting": "5xx", "active": "5xx"},
    "account_b": {"posting": "5xx"},
}

with

hive-nectar --keys key_file.json command

When set, the wallet cannot be used.

Common Commands

First, you may like to import your Hive account:

hive-nectar importaccount

You can also import individual private keys:

hive-nectar addkey <private_key>

Listing accounts:

hive-nectar listaccounts

Show balances:

hive-nectar balance account_name1 account_name2

Sending funds:

hive-nectar transfer --account <account_name> <recipient_name> 100 HIVE memo

Upvoting a post:

hive-nectar upvote --account <account_name> https://hive.blog/funny/@mynameisbrian/the-content-stand-a-comic

Setting Defaults

For a more convenient use of hive-nectar as well as the nectar library, you can set some defaults. This is especially useful if you have a single Hive account.

hive-nectar set default_account test
hive-nectar set default_vote_weight 100

hive-nectar config
 +---------------------+--------+
 | Key                 | Value  |
 +---------------------+--------+
 | default_account     | test   |
 | default_vote_weight | 100    |
 +---------------------+--------+

If you’ve set up your default_account, you can now send funds by omitting this field:

hive-nectar transfer <recipient_name> 100 Hive memo

Commands

hive-nectar

Usage

hive-nectar [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...

Options

-n, --node <node>: URL for public Hive API (e.g. https://api.hive.blog)

-o, --offline: Prevent connecting to network

-d, --no-broadcast: Do not broadcast

-t, --testnet: Legacy compatibility flag (no-op, Hive only).

-p, --no-wallet: Do not load the wallet

-x, --unsigned: Nothing will be signed, changes the default value of expires to 3600

-k, --keys <keys>: JSON file that contains account keys, when set, the wallet cannot be used.

-u, --use-ledger: Uses the ledger device Nano S for signing.

--path <path>: BIP32 path from which the keys are derived, when not set, default_path is used.

-e, --expires <expires>: Delay in seconds until transactions are supposed to expire(defaults to 30)

-v, --verbose <verbose>: Verbosity

--version: Show the version and exit.

about

About hive-nectar

Usage

hive-nectar about [OPTIONS]

addkey

Add key to wallet

When no [OPTION] is given, a password prompt for unlocking the wallet and a prompt for entering the private key are shown.

Usage

hive-nectar addkey [OPTIONS]

Options

--unsafe-import-key <unsafe_import_key>: Private key to import to wallet (unsafe, unless shell history is deleted afterwards)

allow

Allow an account/key to interact with your account

foreign_account: The account or key that will be allowed to interact with account.: When not given, password will be asked, from which a public key is derived. This derived key will then interact with your account.

Usage

hive-nectar allow [OPTIONS] [FOREIGN_ACCOUNT]

Options

--permission <permission>: The permission to grant (defaults to “posting”)

-a, --account <account>: The account to allow action for

-w, --weight <weight>: The weight to use instead of the (full) threshold. If the weight is smaller than the threshold, additional signatures are required

-t, --threshold <threshold>: The permission’s threshold that needs to be reached by signatures to be able to interact

-e, --export <export>: When set, transaction is stored in a file

Arguments

FOREIGN_ACCOUNT: Optional argument

approvewitness

Approve a witnesses

Usage

hive-nectar approvewitness [OPTIONS] WITNESS

Options

-a, --account <account>: Your account

-e, --export <export>: When set, transaction is stored in a file

Arguments

WITNESS: Required argument

balance

Shows balance

Usage

hive-nectar balance [OPTIONS] [ACCOUNT]...

Arguments

ACCOUNT: Optional argument(s)

beneficiaries

Set beneficaries

Usage

hive-nectar beneficiaries [OPTIONS] AUTHORPERM [BENEFICIARIES]...

Options

-e, --export <export>: When set, transaction is stored in a file

Arguments

AUTHORPERM: Required argument

BENEFICIARIES: Optional argument(s)

broadcast

broadcast a signed transaction

Usage

hive-nectar broadcast [OPTIONS]

Options

-f, --file <file>: Load transaction from file. If “-”, read from stdin (defaults to “-“)

buy

Buy HIVE or HBD from the internal market

Limit buy price denoted in (HBD per HIVE)

Usage

hive-nectar buy [OPTIONS] AMOUNT ASSET [PRICE]

Options

-a, --account <account>: Buy with this account (defaults to “default_account”)

--orderid <orderid>: Set an orderid

-e, --export <export>: When set, transaction is stored in a file

Arguments

AMOUNT: Required argument

ASSET: Required argument

PRICE: Optional argument

cancel

Cancel order in the internal market

Usage

hive-nectar cancel [OPTIONS] ORDERID

Options

-a, --account <account>: Sell with this account (defaults to “default_account”)

-e, --export <export>: When set, transaction is stored in a file

Arguments

ORDERID: Required argument

chainconfig

Prints chain config in a table

Usage

hive-nectar chainconfig [OPTIONS]

changekeys

Changes all keys for the specified account Keys are given in their public form. Asks for the owner key for broadcasting the op to the chain.

Usage

hive-nectar changekeys [OPTIONS] ACCOUNT

Options

--owner <owner>: Main owner public key - when not given, a passphrase is used to create keys.

--active <active>: Active public key - when not given, a passphrase is used to create keys.

--posting <posting>: posting public key - when not given, a passphrase is used to create keys.

--memo <memo>: Memo public key - when not given, a passphrase is used to create keys.

-i, --import-pub <import_pub>: Load public keys from file.

-e, --export <export>: When set, transaction is stored in a file

Arguments

ACCOUNT: Required argument

changerecovery

Changes the recovery account with the owner key (needs 30 days to be active)

Usage

hive-nectar changerecovery [OPTIONS] NEW_RECOVERY_ACCOUNT

Options

-a, --account <account>: Change the recovery account from this account

-e, --export <export>: When set, transaction is stored in a file

Arguments

NEW_RECOVERY_ACCOUNT: Required argument

changewalletpassphrase

Change wallet password

Usage

hive-nectar changewalletpassphrase [OPTIONS]

claimaccount

Claim account for claimed account creation.

Usage

hive-nectar claimaccount [OPTIONS] CREATOR

Options

--fee <fee>: When fee is 0 (default) a subsidized account is claimed and can be created later with create_claimed_account

-n, --number <number>: Number of subsidized accounts to be claimed (default = 1), when fee = 0 HIVE

-e, --export <export>: When set, transaction is stored in a file (should be used with number = 1)

Arguments

CREATOR: Required argument

claimreward

Claim reward balances

By default, this will claim all outstanding balances.

Usage

hive-nectar claimreward [OPTIONS] [ACCOUNT]

Options

--reward_sbd <reward_sbd>: Amount of HBD you would like to claim

--reward_vests <reward_vests>: Amount of VESTS you would like to claim

--claim_all_sbd: Claim all HBD, overwrites reward_sbd

--claim_all_vests: Claim all VESTS, overwrites reward_vests

-e, --export <export>: When set, transaction is stored in a file

Arguments

ACCOUNT: Optional argument

config

Shows local configuration

Usage

hive-nectar config [OPTIONS]

convert

Convert HBD to HIVE (takes ~1 week to settle)

Usage

hive-nectar convert [OPTIONS] AMOUNT

Options

-a, --account <account>: Powerup from this account

-e, --export <export>: When set, transaction is stored in a file

Arguments

AMOUNT: Required argument

createpost

Creates a new markdown file with YAML header

Usage

hive-nectar createpost [OPTIONS] MARKDOWN_FILE

Options

-a, --account <account>: Account are you posting from

-t, --title <title>: Title of the post

-g, --tags <tags>: A komma separated list of tags to go with the post.

-c, --community <community>: Name of the community (optional)

-b, --beneficiaries <beneficiaries>: Post beneficiaries (komma separated, e.g. a:10%,b:20%)

-h, --percent-hbd <percent_hbd>: 50% HBD/50% HP is 10000 (default), 100% HP is 0

-m, --max-accepted-payout <max_accepted_payout>: Default is 1000000.000 [HBD]

-n, --no-parse-body: Disable parsing of links, tags and images

Arguments

MARKDOWN_FILE: Required argument

createwallet

Create new wallet with a new password

Usage

hive-nectar createwallet [OPTIONS]

Options

--wipe: Wipe old wallet without prompt.

curation

Lists curation rewards of all votes for authorperm

When authorperm is empty or “all”, the curation rewards for all account votes are shown.

authorperm can also be a number. e.g. 5 is equivalent to the fifth account vote in the given time duration (default is 7 days)

Usage

hive-nectar curation [OPTIONS] [AUTHORPERM]

Options

-a, --account <account>: Show only curation for this account

-m, --limit <limit>: Show only the first minutes

-v, --min-vote <min_vote>: Show only votes higher than the given value

-w, --max-vote <max_vote>: Show only votes lower than the given value

-x, --min-performance <min_performance>: Show only votes with performance higher than the given value in HBD

-y, --max-performance <max_performance>: Show only votes with performance lower than the given value in HBD

--payout <payout>: Show the curation for a potential payout in HBD as float

-e, --export <export>: Export results to HTML-file

-s, --short: Show only Curation without sum

-l, --length <length>: Limits the permlink character length

-p, --permlink: Show the permlink for each entry

-t, --title: Show the title for each entry

-d, --days <days>: Limit shown rewards by this amount of days (default: 7), max is 7 days.

Arguments

AUTHORPERM: Optional argument

currentnode

Sets the currently working node at the first place in the list

Usage

hive-nectar currentnode [OPTIONS]

Options

--version: Returns only the raw version value

--url: Returns only the raw url value

customjson

Broadcasts a custom json

First parameter is the cusom json id, the second field is a json file or a json key value combination e.g. hive-nectar customjson -a thecrazygm dw-heist username thecrazygm amount 100

Usage

hive-nectar customjson [OPTIONS] JSONID [JSON_DATA]...

Options

-a, --account <account>: The account which broadcasts the custom_json

-t, --active: When set, the active key is used for broadcasting

-e, --export <export>: When set, transaction is stored in a file

Arguments

JSONID: Required argument

JSON_DATA: Optional argument(s)

decrypt

decrypt a (or more than one) decrypted memo/file with your memo key

Usage

hive-nectar decrypt [OPTIONS] [MEMO]...

Options

-a, --account <account>: Account which decrypts the memo with its memo key

-o, --output <output>: Output file name. Result is stored, when set instead of printed.

-i, --info: Shows information about public keys and used nonce

-t, --text: Reads the text file content

-b, --binary: Reads the binary file content

Arguments

MEMO: Optional argument(s)

delegate

Delegate (start delegating VESTS to another account)

amount is in VESTS / HIVE Power

Usage

hive-nectar delegate [OPTIONS] AMOUNT TO_ACCOUNT

Options

-a, --account <account>: Delegate from this account

-e, --export <export>: When set, transaction is stored in a file

Arguments

AMOUNT: Required argument

TO_ACCOUNT: Required argument

delete

delete a post/comment

POST is @author/permlink

Usage

hive-nectar delete [OPTIONS] POST

Options

-a, --account <account>: Account name

-e, --export <export>: When set, transaction is stored in a file

Arguments

POST: Required argument

delkey

Delete key from the wallet

PUB is the public key from the private key which will be deleted from the wallet

Usage

hive-nectar delkey [OPTIONS] PUB

Options

--confirm: Please confirm!

Arguments

PUB: Required argument

delprofile

Delete a variable in an account’s profile

Usage

hive-nectar delprofile [OPTIONS] VARIABLE...

Options

-a, --account <account>: delprofile as this user

-e, --export <export>: When set, transaction is stored in a file

Arguments

VARIABLE: Required argument(s)

delproxy

Delete your witness/proposal system proxy

Usage

hive-nectar delproxy [OPTIONS]

Options

-a, --account <account>: Your account

-e, --export <export>: When set, transaction is stored in a file

disallow

Remove allowance an account/key to interact with your account

Usage

hive-nectar disallow [OPTIONS] [FOREIGN_ACCOUNT]

Options

-p, --permission <permission>: The permission to grant (defaults to “posting”)

-a, --account <account>: The account to disallow action for

-w, --weight <weight>: The weight to use instead of the (full) threshold. If the weight is smaller than the threshold, additional signatures are required

-t, --threshold <threshold>: The permission’s threshold that needs to be reached by signatures to be able to interact

-e, --export <export>: When set, transaction is stored in a file

Arguments

FOREIGN_ACCOUNT: Optional argument

disapprovewitness

Disapprove a witnesses

Usage

hive-nectar disapprovewitness [OPTIONS] WITNESS

Options

-a, --account <account>: Your account

-e, --export <export>: When set, transaction is stored in a file

Arguments

WITNESS: Required argument

download

Download body with yaml header

Usage

hive-nectar download [OPTIONS] [PERMLINK]...

Options

-a, --account <account>: Account are you posting from

-s, --save: Saves markdown in current directoy as date_permlink.md

-e, --export <export>: Export markdown to given a md-file name

Arguments

PERMLINK: Optional argument(s)

downvote

Downvote a post/comment

POST is @author/permlink

Usage

hive-nectar downvote [OPTIONS] POST

Options

-a, --account <account>: Downvoter account name

-w, --weight <weight>: Downvote weight (from 0.1 to 100.0)

-e, --export <export>: When set, transaction is stored in a file

Arguments

POST: Required argument

draw

Generate pseudo-random numbers based on trx id, block id and previous block id.

When using –reply, the result is directly broadcasted as comment

Usage

hive-nectar draw [OPTIONS]

Options

-b, --block <block>: Select a block number, when skipped the latest block is used.

-t, --trx-id <trx_id>: Select a trx-id, When skipped, the latest one is used.

-d, --draws <draws>: Number of draws (default = 1)

-p, --participants <participants>: Number of participants or file name including participants (one participant per line), (default = 100)

-h, --hashtype <hashtype>: Can be md5, sha256, sha512 (default = sha256)

-s, --separator <separator>: Is used for sha256 and sha512 to seperate the draw number from the seed (default = ,)

-a, --account <account>: The account which broadcasts the reply

-r, --reply <reply>: Parent post/comment authorperm. When set, the results will be broadcasted as reply to this authorperm.

-w, --without-replacement: When set, numbers are drawed without replacement.

-m, --markdown: When set, results are returned in markdown format

encrypt

encrypt a (or more than one) memo text/file with the your memo key

Usage

hive-nectar encrypt [OPTIONS] RECEIVER [MEMO]...

Options

-a, --account <account>: Account which encrypts the memo with its memo key

-o, --output <output>: Output file name. Result is stored, when set instead of printed.

-t, --text: Reads the text file content

-b, --binary: Reads the binary file content

Arguments

RECEIVER: Required argument

MEMO: Optional argument(s)

featureflags

Get the account’s feature flags.

The request has to be signed by the requested account or an admin account.

Usage

hive-nectar featureflags [OPTIONS] [ACCOUNT]

Options

-s, --signing-account <signing_account>: Signing account, when empty account is used.

Arguments

ACCOUNT: Optional argument

follow

Follow another account

Can be blog ignore blacklist unblacklist follow_blacklist unfollow_blacklist follow_muted unfollow_muted on HIVE

Usage

hive-nectar follow [OPTIONS] [FOLLOW]...

Options

-a, --account <account>: Follow from this account

--what <what>: Follow these objects (defaults to [“blog”])

-e, --export <export>: When set, transaction is stored in a file

Arguments

FOLLOW: Optional argument(s)

follower

Get information about followers

Usage

hive-nectar follower [OPTIONS] [ACCOUNT]...

Arguments

ACCOUNT: Optional argument(s)

following

Get information about following

Usage

hive-nectar following [OPTIONS] [ACCOUNT]...

Arguments

ACCOUNT: Optional argument(s)

followlist

Get information about followed lists

follow_type can be blog On Hive, follow type can also be one the following: blacklisted, follow_blacklist, muted, or follow_muted

Usage

hive-nectar followlist [OPTIONS] FOLLOW_TYPE

Options

-a, --account <account>: Get follow list for this account

-l, --limit <limit>: Liimts the returned accounts

Arguments

FOLLOW_TYPE: Required argument

history

Returns account history operations as table

Usage

hive-nectar history [OPTIONS] [ACCOUNT]

Options

-l, --limit <limit>: Defines how many ops should be printed (default=10)

-s, --sort <sort>: Defines the printing sorting, 1 ->, -1 <- (default=-1)

-m, --max-length <max_length>: Maximum printed string length

-v, --virtual-ops: When set, virtual ops are also shown

-o, --only-ops <only_ops>: Included komma seperated list of op types, which limits the shown operations. When set, virtual-ops is always set to true

-e, --exclude-ops <exclude_ops>: Excluded komma seperated list of op types, which limits the shown operations.

-j, --json-file <json_file>: When set, the results are written into a json file

Arguments

ACCOUNT: Optional argument

importaccount

Import an account using a passphrase

Usage

hive-nectar importaccount [OPTIONS] ACCOUNT

Options

-r, --roles <roles>: Import specified keys (owner, active, posting, memo).

-i, --import-coldcard <import_coldcard>: Text file with a BIP85 WIF generated by a coldcard. The imported WIF is used as passphrase

-w, --wif <wif>: Defines how many times the password is replaced by its WIF representation for password based keys (default = 0 or 1 when importing a cold card wif).

Arguments

ACCOUNT: Required argument

info

Show basic blockchain info

General information about the blockchain, a block, an account, a post/comment and a public key

Usage

hive-nectar info [OPTIONS] [OBJECTS]...

Arguments

OBJECTS: Optional argument(s)

interest

Get information about interest payment

Usage

hive-nectar interest [OPTIONS] [ACCOUNT]...

Arguments

ACCOUNT: Optional argument(s)

keygen

Creates a new random BIP39 key and prints its derived private key and public key. The generated key is not stored. Can also be used to create new keys for an account. Can also be used to derive account keys from a password or BIP39 wordlist.

Usage

hive-nectar keygen [OPTIONS]

Options

-l, --import-word-list: Imports a BIP39 wordlist and derives a private and public key

--strength <strength>: Defines word list length for BIP39 (default = 256).

-p, --passphrase: Sets a BIP39 passphrase

-m, --path <path>: Sets a path for BIP39 key creations. When path is set, network, role, account_keys, account and sequence is not used

-n, --network <network>: Network index for BIP39 (default is 13 for Hive)

-r, --role <role>: Defines which key role should be created (default = owner).

-k, --account-keys: Derives four BIP39 keys for each role

-s, --sequence <sequence>: Sequence key number, when using BIP39 (default is 0)

-a, --account <account>: sequence number for BIP39 key, default = 0

-w, --wif <wif>: Defines how many times the password is replaced by its WIF representation for password based keys (default = 0).

-u, --export-pub <export_pub>: Exports the public account keys to a json file for account creation or keychange

-e, --export <export>: The results are stored in a text file and will not be shown

listaccounts

Show stored accounts

Can be used with the ledger to obtain all accounts that uses pubkeys derived from this ledger

Usage

hive-nectar listaccounts [OPTIONS]

Options

-r, --role <role>: When set, limits the shown keys for this role

-a, --max-account-index <max_account_index>: Set maximum account index to check pubkeys (only when using ledger)

-s, --max-sequence <max_sequence>: Set maximum key sequence to check pubkeys (only when using ledger)

listdelegations

List all outgoing delegations from an account.

The default account is used if no other account name is given as: option to this command.

Usage

hive-nectar listdelegations [OPTIONS]

Options

-a, --account <account>: List outgoing delegations from this account

listkeys

Show stored keys

Can be used to receive and approve the pubkey obtained from the ledger

Usage

hive-nectar listkeys [OPTIONS]

Options

-p, --path <path>: Set path (when using ledger)

-a, --ledger-approval: When set, you can confirm the shown pubkey on your ledger.

message

Sign and verify a message

Usage

hive-nectar message [OPTIONS] [MESSAGE_FILE]

Options

-a, --account <account>: Account which should sign

-v, --verify: Verify a message instead of signing it

Arguments

MESSAGE_FILE: Optional argument

mute

Mute another account

Usage

hive-nectar mute [OPTIONS] MUTE

Options

-a, --account <account>: Mute from this account

--what <what>: Mute these objects (defaults to [“ignore”])

-e, --export <export>: When set, transaction is stored in a file

Arguments

MUTE: Required argument

muter

Get information about muter

Usage

hive-nectar muter [OPTIONS] [ACCOUNT]...

Arguments

ACCOUNT: Optional argument(s)

muting

Get information about muting

Usage

hive-nectar muting [OPTIONS] [ACCOUNT]...

Arguments

ACCOUNT: Optional argument(s)

newaccount

Create a new account Default setting is that a fee is payed for account creation Use –create-claimed-account for free account creation

Please use keygen and set public keys

Usage

hive-nectar newaccount [OPTIONS] ACCOUNTNAME

Options

-a, --account <account>: Account that pays the fee or uses account tickets

--owner <owner>: Main public owner key - when not given, a passphrase is used to create keys.

--active <active>: Active public key - when not given, a passphrase is used to create keys.

--memo <memo>: Memo public key - when not given, a passphrase is used to create keys.

--posting <posting>: posting public key - when not given, a passphrase is used to create keys.

-w, --wif <wif>: Defines how many times the password is replaced by its WIF representation for password based keys (default = 0).

-c, --create-claimed-account: Instead of paying the account creation fee a subsidized account is created.

-i, --import-pub <import_pub>: Load public keys from file.

-e, --export <export>: When set, transaction is stored in a file

Arguments

ACCOUNTNAME: Required argument

nextnode

Uses the next node in list

Usage

hive-nectar nextnode [OPTIONS]

Options

--results: Shows result of changing the node.

notifications

Show notifications of an account

Usage

hive-nectar notifications [OPTIONS] [ACCOUNT]

Options

-l, --limit <limit>: Limits shown notifications

-a, --all: Show all notifications (when not set, only unread are shown)

-m, --mark_as_read: Broadcast a mark all as read custom json

-r, --replies: Show only replies

-t, --mentions: Show only mentions

-f, --follows: Show only follows

-v, --votes: Show only upvotes

-b, --reblogs: Show only reblogs

-s, --reverse: Reverse sorting of notifications

Arguments

ACCOUNT: Optional argument

openorders

Show open orders

Usage

hive-nectar openorders [OPTIONS] [ACCOUNT]

Arguments

ACCOUNT: Optional argument

orderbook

Obtain orderbook of the internal market

Usage

hive-nectar orderbook [OPTIONS]

Options

--chart: Enable charting

-l, --limit <limit>: Limit number of returned open orders (default 25)

--show-date: Show dates

-w, --width <width>: Plot width (default 75)

-h, --height <height>: Plot height (default 15)

--ascii: Use only ascii symbols

parsewif

Parse a WIF private key without importing

Usage

hive-nectar parsewif [OPTIONS]

Options

--unsafe-import-key <unsafe_import_key>: WIF key to parse (unsafe, unless shell history is deleted afterwards)

passwordgen

Creates a new password based key and prints its derived private key and public key. The generated key is not stored. The password is used to create new keys for an account.

Usage

hive-nectar passwordgen [OPTIONS]

Options

-r, --role <role>: Defines which key role should be created. When owner is not set as role and an cold card wif is imported, the Master Password is not shown. (default = owner,active,posting,memo when creating account keys).

-a, --account <account>: account name for password based key generation

-i, --import-password: Imports a password and derives all four account keys

-o, --import-coldcard <import_coldcard>: Text file with a BIP85 WIF generated by a coldcard. The imported WIF is used to derives all four account keys

-w, --wif <wif>: Defines how many times the password is replaced by its WIF representation for password based keys (default = 0 or 1 when importing a cold card wif).

-u, --export-pub <export_pub>: Exports the public account keys to a json file for account creation or keychange

-e, --export <export>: The results are stored in a text file and will not be shown

pending

Lists pending rewards

Usage

hive-nectar pending [OPTIONS] [ACCOUNTS]...

Options

-s, --only-sum: Show only the sum

-p, --post: Show pending post payout

-c, --comment: Show pending comments payout

-v, --curation: Shows pending curation

-l, --length <length>: Limits the permlink character length

-a, --author: Show the author for each entry

-e, --permlink: Show the permlink for each entry

-t, --title: Show the title for each entry

-d, --days <days>: Limit shown rewards by this amount of days (default: 7), max is 7 days.

-f, --from <_from>: Start day from which on rewards are shown (default: 0), max is 7 days.

Arguments

ACCOUNTS: Optional argument(s)

permissions

Show permissions of an account

Usage

hive-nectar permissions [OPTIONS] [ACCOUNT]

Arguments

ACCOUNT: Optional argument

pingnode

Returns the answer time in milliseconds

Usage

hive-nectar pingnode [OPTIONS]

Options

-s, --sort: Sort all nodes by ping value

-r, --remove: Remove node with errors from list

post

broadcasts a post/comment. All image links which links to a file will be uploaded. The yaml header can contain:

— title: your title tags: tag1,tag2 community: hive-100000 beneficiaries: hive-nectar:5%,thecrazygm:5% —

Usage

hive-nectar post [OPTIONS] MARKDOWN_FILE

Options

-a, --account <account>: Account are you posting from

-t, --title <title>: Title of the post

-p, --permlink <permlink>: Manually set the permlink (optional)

-g, --tags <tags>: A komma separated list of tags to go with the post.

-r, --reply-identifier <reply_identifier>: Identifier of the parent post/comment, when set a comment is broadcasted

-c, --community <community>: Name of the community (optional)

-u, --canonical-url <canonical_url>: Canonical url, can also set to https://hive.blog or https://peakd.com (optional)

-b, --beneficiaries <beneficiaries>: Post beneficiaries (komma separated, e.g. a:10%,b:20%)

-h, --percent-hbd <percent_hbd>: 50% HBD/50% HP is 10000 (default), 100% HP is 0

-m, --max-accepted-payout <max_accepted_payout>: Default is 1000000.000 [HBD]

-n, --no-parse-body: Disable parsing of links, tags and images

-e, --no-patch-on-edit: Disable patch posting on edits (when the permlink already exists)

--export <export>: When set, transaction is stored in a file

Arguments

MARKDOWN_FILE: Required argument

power

Shows vote power and bandwidth

Usage

hive-nectar power [OPTIONS] [ACCOUNT]...

Arguments

ACCOUNT: Optional argument(s)

powerdown

Power down (start withdrawing VESTS from Hive Power)

amount is in VESTS

Usage

hive-nectar powerdown [OPTIONS] AMOUNT

Options

-a, --account <account>: Powerup from this account

-e, --export <export>: When set, transaction is stored in a file

Arguments

AMOUNT: Required argument

powerdownroute

Setup a powerdown route

Usage

hive-nectar powerdownroute [OPTIONS] TO

Options

--percentage <percentage>: The percent of the withdraw to go to the “to” account

-a, --account <account>: Powerup from this account

--auto_vest: Set to true if the from account should receive the VESTS asVESTS, or false if it should receive them as HIVE.

-e, --export <export>: When set, transaction is stored in a file

Arguments

TO: Required argument

powerup

Power up (vest HIVE into Hive Power)

Usage

hive-nectar powerup [OPTIONS] AMOUNT

Options

-a, --account <account>: Powerup from this account

-t, --to <to>: Powerup this account

-e, --export <export>: When set, transaction is stored in a file

Arguments

AMOUNT: Required argument

pricehistory

Show price history

Usage

hive-nectar pricehistory [OPTIONS]

Options

-w, --width <width>: Plot width (default 75)

-h, --height <height>: Plot height (default 15)

--ascii: Use only ascii symbols

reblog

Reblog an existing post

Usage

hive-nectar reblog [OPTIONS] IDENTIFIER

Options

-a, --account <account>: Reblog as this user

Arguments

IDENTIFIER: Required argument

reply

replies to a comment

Usage

hive-nectar reply [OPTIONS] AUTHORPERM BODY

Options

-a, --account <account>: Account are you posting from

-t, --title <title>: Title of the post

-e, --export <export>: When set, transaction is stored in a file

Arguments

AUTHORPERM: Required argument

BODY: Required argument

rewards

Lists received rewards

Usage

hive-nectar rewards [OPTIONS] [ACCOUNTS]...

Options

-s, --only-sum: Show only the sum

-p, --post: Show post payout

-c, --comment: Show comments payout

-v, --curation: Shows curation

-l, --length <length>: Limits the permlink character length

-a, --author: Show the author for each entry

-e, --permlink: Show the permlink for each entry

-t, --title: Show the title for each entry

-d, --days <days>: Limit shown rewards by this amount of days (default: 7)

-w, --witness: Show witness (producer) rewards

Arguments

ACCOUNTS: Optional argument(s)

sell

Sell HIVE or HBD from the internal market

Limit sell price denoted in (HBD per HIVE)

Usage

hive-nectar sell [OPTIONS] AMOUNT ASSET [PRICE]

Options

-a, --account <account>: Sell with this account (defaults to “default_account”)

--orderid <orderid>: Set an orderid

-e, --export <export>: When set, transaction is stored in a file

Arguments

AMOUNT: Required argument

ASSET: Required argument

PRICE: Optional argument

set

Set default_account, default_vote_weight or nodes

set [key] [value]

Examples:

Set the default vote weight to 50 %: set default_vote_weight 50

Usage

hive-nectar set [OPTIONS] KEY VALUE

Arguments

KEY: Required argument

VALUE: Required argument

setprofile

Set a variable in an account’s profile

Usage

hive-nectar setprofile [OPTIONS] [VARIABLE] [VALUE]

Options

-a, --account <account>: setprofile as this user

-p, --pair <pair>: “Key=Value” pairs

-e, --export <export>: When set, transaction is stored in a file

Arguments

VARIABLE: Optional argument

VALUE: Optional argument

setproxy

Set your witness/proposal system proxy

Usage

hive-nectar setproxy [OPTIONS] PROXY

Options

-a, --account <account>: Your account

-e, --export <export>: When set, transaction is stored in a file

Arguments

PROXY: Required argument

sign

Sign a provided transaction with available and required keys

Usage

hive-nectar sign [OPTIONS]

Options

-i, --file <file>: Load transaction from file. If “-”, read from stdin (defaults to “-“)

-o, --outfile <outfile>: Load transaction from file. If “-”, read from stdin (defaults to “-“)

stream

Stream operations

Usage

hive-nectar stream [OPTIONS]

Options

-n, --lines <lines>: Defines how many ops should be shown

-h, --head: Stream mode: When set, it is set to head (default is irreversible)

-t, --table: Output as table

-f, --follow: Constantly stream output

ticker

Show ticker

Usage

hive-nectar ticker [OPTIONS]

tradehistory

Show price history

Usage

hive-nectar tradehistory [OPTIONS]

Options

-d, --days <days>: Limit the days of shown trade history (default 7)

--hours <hours>: Limit the intervall history intervall (default 2 hours)

-l, --limit <limit>: Limit number of trades which is fetched at each intervall point (default 100)

-w, --width <width>: Plot width (default 75)

-h, --height <height>: Plot height (default 15)

--ascii: Use only ascii symbols

transfer

Transfer HBD or HIVE

Usage

hive-nectar transfer [OPTIONS] TO AMOUNT ASSET [MEMO]

Options

-a, --account <account>: Transfer from this account

-e, --export <export>: When set, transaction is stored in a file

Arguments

TO: Required argument

AMOUNT: Required argument

ASSET: Required argument

MEMO: Optional argument

unfollow

Unfollow/Unmute another account

Usage

hive-nectar unfollow [OPTIONS] UNFOLLOW

Options

-a, --account <account>: UnFollow/UnMute from this account

-e, --export <export>: When set, transaction is stored in a file

Arguments

UNFOLLOW: Required argument

updatememokey

Update an account’s memo key

Usage

hive-nectar updatememokey [OPTIONS]

Options

-a, --account <account>: The account to updatememokey action for

--key <key>: The new memo key

-e, --export <export>: When set, transaction is stored in a file

updatenodes

Update the nodelist from @fullnodeupdate

Usage

hive-nectar updatenodes [OPTIONS]

Options

-s, --show: Prints the updated nodes

-t, --test: Do change the node list, only print the newest nodes setup.

--only-https: Use only https nodes.

--only-wss: Use only websocket nodes.

uploadimage

Usage

hive-nectar uploadimage [OPTIONS] IMAGE

Options

-a, --account <account>: Account name

-n, --image-name <image_name>: Image name

Arguments

IMAGE: Required argument

upvote

Upvote a post/comment

POST is @author/permlink

Usage

hive-nectar upvote [OPTIONS] POST

Options

-w, --weight <weight>: Vote weight (from 0.1 to 100.0)

-a, --account <account>: Voter account name

-e, --export <export>: When set, transaction is stored in a file

Arguments

POST: Required argument

userdata

Get the account’s email address and phone number.

The request has to be signed by the requested account or an admin account.

Usage

hive-nectar userdata [OPTIONS] [ACCOUNT]

Options

-s, --signing-account <signing_account>: Signing account, when empty account is used.

Arguments

ACCOUNT: Optional argument

verify

Returns the public signing keys for a block

Usage

hive-nectar verify [OPTIONS] [BLOCKNUMBER]

Options

-t, --trx <trx>: Show only one transaction number

-u, --use-api: Uses the get_potential_signatures api call

Arguments

BLOCKNUMBER: Optional argument

votes

List outgoing/incoming account votes

Usage

hive-nectar votes [OPTIONS] [ACCOUNT]

Options

--direction <direction>: in or out

-o, --outgoing: Show outgoing votes

-i, --incoming: Show incoming votes

-d, --days <days>: Limit shown vote history by this amount of days (default: 2)

-e, --export <export>: Export results to TXT-file

Arguments

ACCOUNT: Optional argument

walletinfo

Show info about wallet

Usage

hive-nectar walletinfo [OPTIONS]

Options

-u, --unlock: Unlock wallet

-l, --lock: Lock wallet

witness

List witness information

Usage

hive-nectar witness [OPTIONS] WITNESS

Arguments

WITNESS: Required argument

witnesscreate

Create a witness

Usage

hive-nectar witnesscreate [OPTIONS] WITNESS PUB_SIGNING_KEY

Options

--maximum_block_size <maximum_block_size>: Max block size

--account_creation_fee <account_creation_fee>: Account creation fee

--hbd_interest_rate <hbd_interest_rate>: HBD interest rate in percent

--url <url>: Witness URL

-e, --export <export>: When set, transaction is stored in a file

Arguments

WITNESS: Required argument

PUB_SIGNING_KEY: Required argument

witnessdisable

Disable a witness

Usage

hive-nectar witnessdisable [OPTIONS] WITNESS

Options

-e, --export <export>: When set, transaction is stored in a file

Arguments

WITNESS: Required argument

witnessenable

Enable a witness

Usage

hive-nectar witnessenable [OPTIONS] WITNESS SIGNING_KEY

Options

-e, --export <export>: When set, transaction is stored in a file

Arguments

WITNESS: Required argument

SIGNING_KEY: Required argument

witnesses

List witnesses

Usage

hive-nectar witnesses [OPTIONS] [ACCOUNT]

Options

--limit <limit>: How many witnesses should be shown

Arguments

ACCOUNT: Optional argument

witnessfeed

Publish price feed for a witness

Usage

hive-nectar witnessfeed [OPTIONS] WITNESS [WIF]

Options

-b, --base <base>: Set base manually, when not set the base is automatically calculated.

-q, --quote <quote>: HBD/HIVE quote manually; when not set, the base is automatically calculated.

--support-peg: Supports peg adjusting the quote, is overwritten by –set-quote!

Arguments

WITNESS: Required argument

WIF: Optional argument

witnessproperties

Update witness properties of witness WITNESS with the witness signing key WIF

Usage

hive-nectar witnessproperties [OPTIONS] WITNESS WIF

Options

--account_creation_fee <account_creation_fee>: Account creation fee (float)

--account_subsidy_budget <account_subsidy_budget>: Account subisidy per block

--account_subsidy_decay <account_subsidy_decay>: Per block decay of the account subsidy pool

--maximum_block_size <maximum_block_size>: Max block size

--hbd_interest_rate <hbd_interest_rate>: HBD interest rate in percent

--new_signing_key <new_signing_key>: Set new signing key (pubkey)

--url <url>: Witness URL

Arguments

WITNESS: Required argument

WIF: Required argument

witnessupdate

Change witness properties

Usage

hive-nectar witnessupdate [OPTIONS]

Options

--witness <witness>: Witness name

--maximum_block_size <maximum_block_size>: Max block size

--account_creation_fee <account_creation_fee>: Account creation fee

--hbd_interest_rate <hbd_interest_rate>: HBD interest rate in percent

--url <url>: Witness URL

--signing_key <signing_key>: Signing Key

-e, --export <export>: When set, transaction is stored in a file

hive-nectar –help

You can see all available commands with hive-nectar --help

 ~ % hive-nectar --help
Usage: hive-nectar [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...

Options:
  -n, --node TEXT        URL for public Hive API (e.g.
                         https://api.hive.blog)
  -o, --offline          Prevent connecting to network
  -d, --no-broadcast     Do not broadcast
  -p, --no-wallet        Do not load the wallet
  -x, --unsigned         Nothing will be signed
  -l, --create-link      Creates hivesigner links from all broadcast
                         operations
  -k, --keys TEXT        JSON file that contains account keys, when set, the
                         wallet cannot be used.
  -u, --use-ledger       Uses the ledger device Nano S for signing.
  --path TEXT            BIP32 path from which the keys are derived, when not
                         set, default_path is used.
  -t, --token            Uses a hivesigner token to broadcast (only broadcast
                         operation with posting permission)
  -e, --expires INTEGER  Delay in seconds until transactions are supposed to
                         expire (defaults to 60)
  -v, --verbose INTEGER  Verbosity
  --version              Show the version and exit.
  --help                 Show this message and exit.

Commands:
  about                   About hive-nectar
  addkey                  Add key to wallet When no [OPTION] is given,...
  addtoken                Add key to wallet When no [OPTION] is given, a...
  allow                   Allow an account/key to interact with your...
                          account...
  approvewitness          Approve a witnesses
  balance                 Shows balance
  beneficiaries           Set beneficaries
  broadcast               broadcast a signed transaction
  buy                     Buy HIVE or HBD from the internal
                          market...
  cancel                  Cancel order in the internal market
  changekeys              Changes all keys for the specified account Keys...
  changerecovery          Changes the recovery account with the owner key...
  changewalletpassphrase  Change wallet password
  claimaccount            Claim account for claimed account creation.
  claimreward             Claim reward balances By default, this will...
  config                  Shows local configuration
  convert                 Convert HBD to Hive (takes a week to...
  createpost              Creates a new markdown file with YAML header
  createwallet            Create new wallet with a new password
  curation                Lists curation rewards of all votes for
                          authorperm...
  currentnode             Sets the currently working node at the first...
  customjson              Broadcasts a custom json First parameter is the...
  decrypt                 decrypt a (or more than one) decrypted memo/file...
  delegate                Delegate (start delegating VESTS to another...
  delete                  delete a post/comment POST is @author/permlink
  delkey                  Delete key from the wallet PUB is the public...
  delprofile              Delete a variable in an account's profile
  delproxy                Delete your witness/proposal system proxy
  deltoken                Delete name from the wallet name is the public...
  disallow                Remove allowance an account/key to interact...
  disapprovewitness       Disapprove a witnesses
  download                Download body with yaml header
  downvote                Downvote a post/comment POST is @author/permlink
  draw                    Generate pseudo-random numbers based on trx id,...
  encrypt                 encrypt a (or more than one) memo text/file with...
  featureflags            Get the account's feature flags.
  follow                  Follow another account
  follower                Get information about followers
  following               Get information about following
  followlist              Get information about followed lists follow_type...
  history                 Returns account history operations as table
  importaccount           Import an account using a passphrase
  info                    Show basic blockchain info General...
  interest                Get information about interest payment
  keygen                  Creates a new random BIP39 key or password based...
  listaccounts            Show stored accounts Can be used with the ledger...
  listkeys                Show stored keys
  listtoken               Show stored token
  message                 Sign and verify a message
  mute                    Mute another account
  muter                   Get information about muter
  muting                  Get information about muting
  newaccount              Create a new account
  nextnode                Uses the next node in list
  notifications           Show notifications of an account
  openorders              Show open orders
  orderbook               Obtain orderbook of the internal market
  parsewif                Parse a WIF private key without importing
  pending                 Lists pending rewards
  permissions             Show permissions of an account
  pingnode                Returns the answer time in milliseconds
  post                    broadcasts a post/comment.
  power                   Shows vote power and bandwidth
  powerdown               Power down (start withdrawing VESTS from...
  powerdownroute          Setup a powerdown route
  powerup                 Power up (vest HIVE as HIVE POWER)
  pricehistory            Show price history
  reblog                  Reblog an existing post
  reply                   replies to a comment
  rewards                 Lists received rewards
  sell                    Sell HIVE or HBD from the internal...
  set                     Set default_account, default_vote_weight or...
  setprofile              Set a variable in an account's profile
  setproxy                Set your witness/proposal system proxy
  sign                    Sign a provided transaction with available and...
  stream                  Stream operations
  ticker                  Show ticker
  tradehistory            Show price history
  transfer                Transfer HBD or HIVE
  unfollow                Unfollow/Unmute another account
  updatememokey           Update an account's memo key
  updatenodes             Update the nodelist from @fullnodeupdate
  uploadimage
  upvote                  Upvote a post/comment POST is @author/permlink
  userdata                Get the account's email address and phone number.
  verify                  Returns the public signing keys for a block
  votes                   List outgoing/incoming account votes
  walletinfo              Show info about wallet
  witness                 List witness information
  witnesscreate           Create a witness
  witnessdisable          Disable a witness
  witnessenable           Enable a witness
  witnesses               List witnesses
  witnessfeed             Publish price feed for a witness
  witnessproperties       Update witness properties of witness WITNESS with...
  witnessupdate           Change witness properties