Bitcoin Forum

Bitcoin => Electrum => Topic started by: yozzh on July 11, 2015, 12:00:51 PM



Title: Is their a guide to the console?
Post by: yozzh on July 11, 2015, 12:00:51 PM
I am looking for a guide to the console. One that explains the various features such as:

addrequest, broadcast, check_seed, create, createmultisig, createrawtx, decrypt, deseed, deserialize, dumpprivkeys, encrypt, freeze, getaddressbalance, getaddresshistory, getaddressunspent, getalias, getbalance, getconfig, getmerkle, getmpk, getprivatekeys, getproof, getpubkeys, getrequest, getseed, getservers, gettransaction, getutxoaddress, help, history, importprivkey, ismine, listaddresses, listcontacts, listrequests, listunspent, make_seed, password, payto, paytomany, restore, rmrequest, searchcontacts, setconfig, setlabel, signmessage, signtransaction, sweep, unfreeze, validateaddress, verifymessage, version.

The Electrum page is not very helpful: https://electrum.orain.org/wiki/List_of_commands (https://electrum.orain.org/wiki/List_of_commands) and the -h option does not work.

Any ideas? Many thanks.


Title: Re: Is their a guide to the console?
Post by: DongSwanson on July 15, 2015, 04:40:20 PM
On the Windows Client?

Code:
help()
gives you all available options

you call every other function the same way:
Code:
functionName(argument1, argument2, argument3, argumentN)

necessary arguments can be found in the source code of the client:
https://github.com/spesmilo/electrum/blob/master/lib/commands.py (https://github.com/spesmilo/electrum/blob/master/lib/commands.py)


Title: Re: Is their a guide to the console?
Post by: Abdussamad on July 18, 2015, 12:51:01 PM
Using your operating system's command line (shell/command prompt NOT electrum console) you can do
Code:
electrum help
and
Code:
electrum help <command_name>
to get command specific help. For example
Code:
electrum help listaddresses