# boostminer

> Mines Boost Jobs on Your CPU

Latest version **0.5.1** (published 2022-09-27) · ISC license · 0 weekly downloads

## Install

```sh
npm install boostminer
pnpm add boostminer
yarn add boostminer
bun add boostminer
```

Provides the command `boostminer`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.1 |
| Published | 2022-09-27 |
| First published | 2021-12-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 17 |
| Unpacked size | 51.3 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | stevenzeiler |

## Links

- npm: https://www.npmjs.com/package/boostminer
- npm.io page: https://npm.io/package/boostminer

## Dependencies (17)

- [bsv](https://npm.io/package/bsv.md) ^1.5.6
- [delay](https://npm.io/package/delay.md) ^5.0.0
- [nconf](https://npm.io/package/nconf.md) ^0.12.0
- [powco](https://npm.io/package/powco.md) ^1.2.0
- [yesno](https://npm.io/package/yesno.md) ^0.3.1
- [filepay](https://npm.io/package/filepay.md) ^2.2.12
- [run-sdk](https://npm.io/package/run-sdk.md) ^0.6.38
- [winston](https://npm.io/package/winston.md) ^3.3.3
- [bluebird](https://npm.io/package/bluebird.md) ^3.7.2
- [boostpow](https://npm.io/package/boostpow.md) ^1.3.5
- [commander](https://npm.io/package/commander.md) ^8.3.0
- [public-ip](https://npm.io/package/public-ip.md) ^4.0.4
- [minercraft](https://npm.io/package/minercraft.md) ^0.0.8
- [superagent](https://npm.io/package/superagent.md) ^6.1.0
- [cli-progress](https://npm.io/package/cli-progress.md) ^3.10.0
- [prompt-async](https://npm.io/package/prompt-async.md) ^0.9.9
- [@runonbitcoin/easy-b](https://npm.io/package/@runonbitcoin/easy-b.md) ^0.1.7

## Recent versions

- 0.5.1 (latest) — 2022-09-27
- 0.5.0 — 2022-07-08
- 0.4.1 — 2022-07-06
- 0.4.0 — 2022-05-10
- 0.3.11 — 2022-05-09
- 0.3.10 — 2022-04-29
- 0.3.8 — 2022-02-17
- 0.3.7 — 2022-02-14
- 0.3.6 — 2022-02-13
- 0.3.5 — 2022-01-28
- 0.3.4 — 2022-01-14
- 0.3.2 — 2022-01-14
- 0.3.1 — 2022-01-14
- 0.3.0 — 2022-01-13
- 0.2.0 — 2022-01-13
- … 5 more at https://npm.io/package/boostminer/versions

## README

# boostminer

Mines Boost Jobs on Your CPU

## Installation

```
> npm install -g boostminer

```
### Usage

```
Usage: boostminer [options] [command]

Options:
  -p, --privatekey <privatekey>             miner private key
  -a, --address <address>                   miner payout address
  -h, --help                                display help for command

Commands:
  upload <filepath>
  start
  wallet
  workjob <job_txid>
  job <txid>
  init
  submitjob <txhex>
  newjob <content> <difficulty> <satoshis>
  help [command]                            display help for command
```
## 

### Initializing boostminer and Funding Wallet
```
> boostminer init

wallet address is <YOUR MINER ADDRESS>

satoshis are required to fund new jobs

```
Send some satoshis so your miner can claim payment for work done

### Running Boostminer

```
> boostminer start
```

### Running with Docker

```
docker run proofofwork/boostminer boostminer start

```

---
_Source: https://npm.io/package/boostminer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._