mirrors/bitcoin-s
1
0
Fork 0
mirror of https://github.com/bitcoin-s/bitcoin-s.git synced 2025-01-19 05:43:51 +01:00
Code Issues Packages Projects Releases Wiki Activity
170242812c
bitcoin-s/docs/applications/cli.md
Nadav Kohen f975e747ef docs: Updated setup and dlc docs (#1895) 
Removed graalvm from cli instructions
2020-08-25 10:33:05 -05:00

1.1 KiB
Raw Blame History

id title
cli CLI

Bitcoin-s command line interface

The cli project is meant to be a bitcoin-s command line interface (cli).

Building the command line interface

You must first have bitcoin-s properly installed on your machine, after which you should be able to build the cli with

$ sbt cli/universal:stage

After running that command you should find the executable here:

bitcoin-s/app/cli/target/universal/stage/bin/bitcoin-s-cli

Executing commands

You can ask the client for help with

 ./app/cli/target/universal/stage/bin/bitcoin-s-cli --help
Usage: bitcoin-s-cli [options] [<cmd>]

  -n, --network <value>  Select the active network.
  --debug                Print debugging information
  -h, --help             Display this help message and exit
  <cmd>                  The command and arguments to be executed. Try bitcoin-s-cli help for a list of all commands

Now you are are ready to start the server that the cli sends commands to. Take a look at our server documentation on how to build and start the server.