Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/carnesen-archive/bitcoin-service-cli

A Node.js command-line interface for managing the bitcoin service `bitcoind`
https://github.com/carnesen-archive/bitcoin-service-cli

bitcoin bitcoind carnesen cli typescript

Last synced: 4 days ago
JSON representation

A Node.js command-line interface for managing the bitcoin service `bitcoind`

Host: GitHub
URL: https://github.com/carnesen-archive/bitcoin-service-cli
Owner: carnesen-archive
License: mit
Created: 2019-02-07T22:01:20.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2019-02-11T14:45:20.000Z (almost 6 years ago)
Last Synced: 2024-11-14T16:23:34.143Z (2 months ago)
Topics: bitcoin, bitcoind, carnesen, cli, typescript
Language: TypeScript
Size: 64.5 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: readme.md
- License: license

Awesome Lists containing this project

README

# @carnesen/bitcoin-service-cli [![Build Status](https://travis-ci.com/carnesen/bitcoin-service-cli.svg?branch=master)](https://travis-ci.com/carnesen/bitcoin-service-cli)
A command-line interface for managing the bitcoin service `bitcoind`

## Install
```
npm install --global @carnesen/bitcoin-service-cli
```

Alternatively, if you don't want to install the package you can run it as a one-off command using `npx`:
```
$ npx @carnesen/bitcoin-service-cli
```

## Usage
```
$ bitcoin-service
Usage: bitcoin-service

Manage the bitcoin service `bitcoind`

Subcommands:

restart, start, stop, status
```
Use the `--help` flag to get usage for a command:
```
$ bitcoin-service start --help
Usage: bitcoin-service start

Options:

[--configFilePath ] : Absolute path to a configuration file
[--bitcoinHome ] : Path to a bitcoin software installation

```
The options `bitcoinHome` and `configFilePath` are described in more detail in [`@carnesen/bitcoin-service`](https://github.com/carnesen/bitcoin-service#readme).

```
$ bitcoin-service start --bitcoinHome /usr/local/bitcoin-0.17.0
Bitcoin server starting
```

## Related
- [@carnesen/bitcoin-service](https://github.com/carnesen/bitcoin-service): A Node.js library for managing the bitcoin service `bitcoind`

- [@carnesen/cli](https://github.com/carnesen/cli): A Node.js library for building command-line interfaces

## License