2019-12-04 14:25:03 +01:00
---
id: cli
2020-03-13 15:54:07 +01:00
title: CLI
2019-12-04 14:25:03 +01:00
---
## Bitcoin-s command line interface
2020-08-25 17:33:05 +02:00
The [cli ](../../app/cli/ ) project is meant to be a bitcoin-s command line interface (cli).
2019-12-04 14:25:03 +01:00
### Building the command line interface
2020-08-25 17:33:05 +02:00
You must first have [bitcoin-s properly installed ](../getting-setup ) on your machine, after which you should be able to build the cli with
2019-12-04 14:25:03 +01:00
```bashrc
2020-08-25 17:33:05 +02:00
$ sbt cli/universal:stage
2019-12-04 14:25:03 +01:00
```
After running that command you should find the executable here:
```bash
2020-08-25 17:33:05 +02:00
bitcoin-s/app/cli/target/universal/stage/bin/bitcoin-s-cli
2019-12-04 14:25:03 +01:00
```
2020-08-25 17:33:05 +02:00
### Executing commands
2019-12-04 14:25:03 +01:00
You can ask the client for help with
```bash
2020-08-25 17:33:05 +02:00
./app/cli/target/universal/stage/bin/bitcoin-s-cli --help
2019-12-04 14:25:03 +01:00
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 ](server.md ) documentation on how to build and start the server.