Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Command Line Interface & Module Architecture #127

Closed
braydonf opened this issue Aug 17, 2015 · 0 comments
Closed

Command Line Interface & Module Architecture #127

braydonf opened this issue Aug 17, 2015 · 0 comments
Assignees

Comments

@braydonf
Copy link
Contributor

Include a command line utility for interacting with a bitcore-node with the following abilities:

Step 1: Install

npm install -g bitcore-node

Install bitcore-node using the global option to add bitcore-node to your path.

Step 2: Configure

bitcore-node create mynode "My Node"
cd mynode
bitcore-node add wallet-service
bitcore-node add insight-api

This will create a new directory and add services to your node via configuration settings similar to:

mynode
├── bitcore-node.json
├── data
│  ├── bitcoin.conf
│  ├── bitcore-node.db
│  │   ├── 163997.ldb
│  │   └── ...
│
├── node_modules
│   ├── bitcore
│   ├── bitcore-node
│   ├── bitcore-wallet-service
│   └── insight-api
└── package.json

With a bitcore-node.json file similar to:

{
  "name": "My Node",
    "modules": [
      "bitcore-wallet-service"
      "insight-api"
   ],
   "datadir": "./data",
   "network": "livenet"
}

And a package.json in the format:

{
  "dependencies": {
    "bitcore": "^0.12.15",
    "bitcore-node": "^1.0.0",
    "bitcore-wallet-service": "^3.0.0",
    "bitcore-insight-api": "^4.0.0"
  }
}

Step 3: Start

$ bitcore-node start

The bitcore-node start command will then dynamically create a node based on the configuration options in bitcore-node.json, load all of the necessary node modules, and configure the node with the enabled services.

@braydonf braydonf added the ready label Aug 18, 2015
@braydonf braydonf self-assigned this Aug 18, 2015
@braydonf braydonf changed the title Command Line Interface Command Line Interface & Module Architecture Aug 18, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants