beempy CLI¶
beempy is a convenient CLI utility that enables you to manage your wallet, transfer funds, check balances and more.
Using the Wallet¶
beempy lets you leverage your BIP38 encrypted wallet to perform various actions on your accounts.
The first time you use beempy, you will be prompted to enter a password. This password will be used to encrypt the beempy wallet, which contains your private keys.
You can change the password via changewalletpassphrase command.
beempy 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 steem library).
To bypass password entry, you can set an environmnet variable UNLOCK
.
UNLOCK=mysecretpassword beempy transfer <recipient_name> 100 STEEM
Common Commands¶
First, you may like to import your Steem account:
beempy importaccount
You can also import individual private keys:
beempy addkey <private_key>
Listing accounts:
beempy listaccounts
Show balances:
beempy balance account_name1 account_name2
Sending funds:
beempy transfer --account <account_name> <recipient_name> 100 STEEM memo
Upvoting a post:
beempy upvote --account <account_name> https://steemit.com/funny/@mynameisbrian/the-content-stand-a-comic
Setting Defaults¶
For a more convenient use of beempy
as well as the beem
library, you can set some defaults.
This is especially useful if you have a single Steem account.
beempy set default_account test
beempy set default_vote_weight 100
beempy 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:
beempy transfer <recipient_name> 100 STEEM memo
Commands¶
beempy¶
beempy [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...
Options
-
-n
,
--node
<node>
¶ URL for public Steem API (e.g. https://api.steemit.com)
-
-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 steemconnect links from all broadcast operations
-
-s
,
--steemconnect
¶
Uses a steemconnect token to broadcast (only broadcast operation with posting permission)
-
-e
,
--expires
<expires>
¶ Delay in seconds until transactions are supposed to expire(defaults to 60)
-
-v
,
--verbose
<verbose>
¶ Verbosity
-
--version
¶
Show the version and exit.
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.
beempy addkey [OPTIONS]
Options
-
--unsafe-import-key
<unsafe_import_key>
¶ Private key to import to wallet (unsafe, unless shell history is deleted afterwards)
addtoken¶
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.
beempy addtoken [OPTIONS] NAME
Options
-
--unsafe-import-token
<unsafe_import_token>
¶ Private key to import to wallet (unsafe, unless shell history is deleted afterwards)
Arguments
-
NAME
¶
Required argument
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.
beempy allow [OPTIONS] [FOREIGN_ACCOUNT]
Options
-
--permission
<permission>
¶ The permission to grant (defaults to “posting”)
-
-a
,
--account
<account>
¶ The account to allow action for
-
--weight
<weight>
¶ The weight to use instead of the (full) threshold. If the weight is smaller than the threshold, additional signatures are required
-
--threshold
<threshold>
¶ The permission’s threshold that needs to be reached by signatures to be able to interact
Arguments
-
FOREIGN_ACCOUNT
¶
Optional argument
approvewitness¶
Approve a witnesses
beempy approvewitness [OPTIONS] WITNESS
Options
-
-a
,
--account
<account>
¶ Your account
Arguments
-
WITNESS
¶
Required argument
balance¶
Shows balance
beempy balance [OPTIONS] [ACCOUNT]...
Arguments
-
ACCOUNT
¶
Optional argument(s)
broadcast¶
broadcast a signed transaction
beempy broadcast [OPTIONS]
Options
-
--file
<file>
¶ Load transaction from file. If “-“, read from stdin (defaults to “-“)
buy¶
Buy STEEM or SBD from the internal market
Limit buy price denoted in (SBD per STEEM)
beempy buy [OPTIONS] AMOUNT ASSET [PRICE]
Options
-
-a
,
--account
<account>
¶ Buy with this account (defaults to “default_account”)
-
--orderid
<orderid>
¶ Set an orderid
Arguments
-
AMOUNT
¶
Required argument
-
ASSET
¶
Required argument
-
PRICE
¶
Optional argument
cancel¶
Cancel order in the internal market
beempy cancel [OPTIONS] ORDERID
Options
-
-a
,
--account
<account>
¶ Sell with this account (defaults to “default_account”)
Arguments
-
ORDERID
¶
Required argument
claimreward¶
Claim reward balances
By default, this will claim all
outstanding balances.
beempy claimreward [OPTIONS] [ACCOUNT]
Options
-
--reward_steem
<reward_steem>
¶ Amount of STEEM you would like to claim
-
--reward_sbd
<reward_sbd>
¶ Amount of SBD you would like to claim
-
--reward_vests
<reward_vests>
¶ Amount of VESTS you would like to claim
Arguments
-
ACCOUNT
¶
Optional argument
convert¶
Convert STEEMDollars to Steem (takes a week to settle)
beempy convert [OPTIONS] AMOUNT
Options
-
-a
,
--account
<account>
¶ Powerup from this account
Arguments
-
AMOUNT
¶
Required argument
createwallet¶
Create new wallet with a new password
beempy 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)
beempy 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
-
-y
,
--max-performance
<max_performance>
¶ Show only votes with perfromance lower than the given value
-
--payout
<payout>
¶ Show the curation for a potential payout in SBD 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
Optional argument
currentnode¶
Sets the currently working node at the first place in the list
beempy currentnode [OPTIONS]
Options
-
--version
¶
Returns only the raw version value
-
--url
¶
Returns only the raw url value
delkey¶
Delete key from the wallet
PUB is the public key from the private key which will be deleted from the wallet
beempy delkey [OPTIONS] PUB
Options
-
--confirm
¶
Please confirm!
Arguments
-
PUB
¶
Required argument
delprofile¶
Delete a variable in an account’s profile
beempy delprofile [OPTIONS] VARIABLE...
Options
-
-a
,
--account
<account>
¶ delprofile as this user
Arguments
-
VARIABLE
¶
Required argument(s)
deltoken¶
Delete name from the wallet
name is the public name from the private token which will be deleted from the wallet
beempy deltoken [OPTIONS] NAME
Options
-
--confirm
¶
Please confirm!
Arguments
-
NAME
¶
Required argument
disallow¶
Remove allowance an account/key to interact with your account
beempy disallow [OPTIONS] [FOREIGN_ACCOUNT]
Options
-
--permission
<permission>
¶ The permission to grant (defaults to “posting”)
-
-a
,
--account
<account>
¶ The account to disallow action for
-
--threshold
<threshold>
¶ The permission’s threshold that needs to be reached by signatures to be able to interact
Arguments
-
FOREIGN_ACCOUNT
¶
Optional argument
disapprovewitness¶
Disapprove a witnesses
beempy disapprovewitness [OPTIONS] WITNESS
Options
-
-a
,
--account
<account>
¶ Your account
Arguments
-
WITNESS
¶
Required argument
downvote¶
Downvote a post/comment
POST is @author/permlink
beempy downvote [OPTIONS] POST [VOTE_WEIGHT]
Options
-
-a
,
--account
<account>
¶ Voter account name
-
-w
,
--weight
<weight>
¶ Vote weight (from 0.1 to 100.0)
Arguments
-
POST
¶
Required argument
-
VOTE_WEIGHT
¶
Optional argument
follow¶
Follow another account
beempy follow [OPTIONS] FOLLOW
Options
-
-a
,
--account
<account>
¶ Follow from this account
-
--what
<what>
¶ Follow these objects (defaults to [“blog”])
Arguments
-
FOLLOW
¶
Required argument
follower¶
Get information about followers
beempy follower [OPTIONS] [ACCOUNT]...
Arguments
-
ACCOUNT
¶
Optional argument(s)
following¶
Get information about following
beempy following [OPTIONS] [ACCOUNT]...
Arguments
-
ACCOUNT
¶
Optional argument(s)
importaccount¶
Import an account using a passphrase
beempy importaccount [OPTIONS] ACCOUNT
Options
-
--roles
<roles>
¶ Import specified keys (owner, active, posting, memo).
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
beempy info [OPTIONS] [OBJECTS]...
Arguments
-
OBJECTS
¶
Optional argument(s)
interest¶
Get information about interest payment
beempy interest [OPTIONS] [ACCOUNT]...
Arguments
-
ACCOUNT
¶
Optional argument(s)
mute¶
Mute another account
beempy mute [OPTIONS] MUTE
Options
-
-a
,
--account
<account>
¶ Mute from this account
-
--what
<what>
¶ Mute these objects (defaults to [“ignore”])
Arguments
-
MUTE
¶
Required argument
muter¶
Get information about muter
beempy muter [OPTIONS] [ACCOUNT]...
Arguments
-
ACCOUNT
¶
Optional argument(s)
muting¶
Get information about muting
beempy muting [OPTIONS] [ACCOUNT]...
Arguments
-
ACCOUNT
¶
Optional argument(s)
newaccount¶
Create a new account
beempy newaccount [OPTIONS] ACCOUNTNAME
Options
-
-a
,
--account
<account>
¶ Account that pays the fee
-
--fee
<fee>
¶ Base Fee to pay. Delegate the rest.
Arguments
-
ACCOUNTNAME
¶
Required argument
nextnode¶
Uses the next node in list
beempy nextnode [OPTIONS]
Options
-
--results
¶
Shows result of changing the node.
openorders¶
Show open orders
beempy openorders [OPTIONS] [ACCOUNT]
Arguments
-
ACCOUNT
¶
Optional argument
orderbook¶
Obtain orderbook of the internal market
beempy 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
beempy parsewif [OPTIONS]
Options
-
--unsafe-import-key
<unsafe_import_key>
¶ WIF key to parse (unsafe, unless shell history is deleted afterwards)
pending¶
Lists pending rewards
beempy 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.
Arguments
-
ACCOUNTS
¶
Optional argument(s)
permissions¶
Show permissions of an account
beempy permissions [OPTIONS] [ACCOUNT]
Arguments
-
ACCOUNT
¶
Optional argument
pingnode¶
Returns the answer time in milliseconds
beempy pingnode [OPTIONS]
Options
-
--raw
¶
Returns only the raw value
-
--sort
¶
Sort all nodes by ping value
-
--remove
¶
Remove node with errors from list
-
--threading
¶
Use a thread for each node
power¶
Shows vote power and bandwidth
beempy power [OPTIONS] [ACCOUNT]...
Arguments
-
ACCOUNT
¶
Optional argument(s)
powerdown¶
Power down (start withdrawing VESTS from Steem POWER)
amount is in VESTS
beempy powerdown [OPTIONS] AMOUNT
Options
-
-a
,
--account
<account>
¶ Powerup from this account
Arguments
-
AMOUNT
¶
Required argument
powerdownroute¶
Setup a powerdown route
beempy 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 STEEM.
Arguments
-
TO
¶
Required argument
powerup¶
Power up (vest STEEM as STEEM POWER)
beempy powerup [OPTIONS] AMOUNT
Options
-
-a
,
--account
<account>
¶ Powerup from this account
-
--to
<to>
¶ Powerup this account
Arguments
-
AMOUNT
¶
Required argument
pricehistory¶
Show price history
beempy pricehistory [OPTIONS]
Options
-
-w
,
--width
<width>
¶ Plot width (default 75)
-
-h
,
--height
<height>
¶ Plot height (default 15)
-
--ascii
¶
Use only ascii symbols
resteem¶
Resteem an existing post
beempy resteem [OPTIONS] IDENTIFIER
Options
-
-a
,
--account
<account>
¶ Resteem as this user
Arguments
-
IDENTIFIER
¶
Required argument
rewards¶
Lists received rewards
beempy 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)
Arguments
-
ACCOUNTS
¶
Optional argument(s)
sell¶
Sell STEEM or SBD from the internal market
Limit sell price denoted in (SBD per STEEM)
beempy sell [OPTIONS] AMOUNT ASSET [PRICE]
Options
-
-a
,
--account
<account>
¶ Sell with this account (defaults to “default_account”)
-
--orderid
<orderid>
¶ Set an orderid
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
beempy set [OPTIONS] KEY VALUE
Arguments
-
KEY
¶
Required argument
-
VALUE
¶
Required argument
setprofile¶
Set a variable in an account’s profile
beempy setprofile [OPTIONS] [VARIABLE] [VALUE]
Options
-
-a
,
--account
<account>
¶ setprofile as this user
-
-p
,
--pair
<pair>
¶ “Key=Value” pairs
Arguments
-
VARIABLE
¶
Optional argument
-
VALUE
¶
Optional argument
sign¶
Sign a provided transaction with available and required keys
beempy sign [OPTIONS]
Options
-
--file
<file>
¶ Load transaction from file. If “-“, read from stdin (defaults to “-“)
tradehistory¶
Show price history
beempy 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)
-
-i
,
--sbd-to-steem
¶
Show ticker in SBD/STEEM
-
-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 SBD/STEEM
beempy transfer [OPTIONS] TO AMOUNT ASSET [MEMO]
Options
-
-a
,
--account
<account>
¶ Transfer from this account
Arguments
-
TO
¶
Required argument
-
AMOUNT
¶
Required argument
-
ASSET
¶
Required argument
-
MEMO
¶
Optional argument
unfollow¶
Unfollow/Unmute another account
beempy unfollow [OPTIONS] UNFOLLOW
Options
-
-a
,
--account
<account>
¶ UnFollow/UnMute from this account
Arguments
-
UNFOLLOW
¶
Required argument
updatememokey¶
Update an account’s memo key
beempy updatememokey [OPTIONS]
Options
-
-a
,
--account
<account>
¶ The account to updatememokey action for
-
--key
<key>
¶ The new memo key
upvote¶
Upvote a post/comment
POST is @author/permlink
beempy upvote [OPTIONS] POST [VOTE_WEIGHT]
Options
-
-w
,
--weight
<weight>
¶ Vote weight (from 0.1 to 100.0)
-
-a
,
--account
<account>
¶ Voter account name
Arguments
-
POST
¶
Required argument
-
VOTE_WEIGHT
¶
Optional argument
verify¶
Returns the public signing keys for a block
beempy 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
beempy 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
beempy walletinfo [OPTIONS]
Options
-
--test-unlock
¶
test if unlock is sucessful
witnesscreate¶
Create a witness
beempy witnesscreate [OPTIONS] WITNESS SIGNING_KEY
Options
-
--maximum_block_size
<maximum_block_size>
¶ Max block size
-
--account_creation_fee
<account_creation_fee>
¶ Account creation fee
-
--sbd_interest_rate
<sbd_interest_rate>
¶ SBD interest rate in percent
-
--url
<url>
¶ Witness URL
Arguments
-
WITNESS
¶
Required argument
-
SIGNING_KEY
¶
Required argument
witnesses¶
List witnesses
beempy witnesses [OPTIONS] [ACCOUNT]
Options
-
--limit
<limit>
¶ How many witnesses should be shown
Arguments
-
ACCOUNT
¶
Optional argument
witnessupdate¶
Change witness properties
beempy 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
-
--sbd_interest_rate
<sbd_interest_rate>
¶ SBD interest rate in percent
-
--url
<url>
¶ Witness URL
-
--signing_key
<signing_key>
¶ Signing Key
beempy –help¶
You can see all available commands with beempy --help
~ % beempy --help
Usage: cli.py [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...
Options:
-n, --node TEXT URL for public Steem API (e.g.
https://api.steemit.com)
-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
-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:
addkey Add key to wallet When no [OPTION] is given,...
allow Allow an account/key to interact with your...
approvewitness Approve a witnesses
balance Shows balance
broadcast broadcast a signed transaction
buy Buy STEEM or SBD from the internal market...
cancel Cancel order in the internal market
changewalletpassphrase Change wallet password
claimreward Claim reward balances By default, this will...
config Shows local configuration
convert Convert STEEMDollars to Steem (takes a week...
createwallet Create new wallet with a new password
currentnode Sets the currently working node at the first...
delkey Delete key from the wallet PUB is the public...
delprofile Delete a variable in an account's profile
disallow Remove allowance an account/key to interact...
disapprovewitness Disapprove a witnesses
downvote Downvote a post/comment POST is...
follow Follow another account
follower Get information about followers
following Get information about following
importaccount Import an account using a passphrase
info Show basic blockchain info General...
interest Get information about interest payment
listaccounts Show stored accounts
listkeys Show stored keys
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
openorders Show open orders
orderbook Obtain orderbook of the internal market
parsewif Parse a WIF private key without importing
permissions Show permissions of an account
pingnode Returns the answer time in milliseconds
power Shows vote power and bandwidth
powerdown Power down (start withdrawing VESTS from...
powerdownroute Setup a powerdown route
powerup Power up (vest STEEM as STEEM POWER)
pricehistory Show price history
resteem Resteem an existing post
sell Sell STEEM or SBD from the internal market...
set Set default_account, default_vote_weight or...
setprofile Set a variable in an account's profile
sign Sign a provided transaction with available...
ticker Show ticker
tradehistory Show price history
transfer Transfer SBD/STEEM
unfollow Unfollow/Unmute another account
updatememokey Update an account's memo key
upvote Upvote a post/comment POST is...
votes List outgoing/incoming account votes
walletinfo Show info about wallet
witnesscreate Create a witness
witnesses List witnesses
witnessupdate Change witness properties