/js-ipfsd-ctl

Control an ipfs node daemon using Node.js

Primary LanguageJavaScriptMIT LicenseMIT

ipfsd-ctl

standard-readme compliant Coverage Status Travis CI Circle CI Dependency Status js-standard-style

Control an ipfs node daemon using Node.js

Table of Contents

Install

Install:

npm install --save ipfsd-ctl

Usage

IPFS daemons are already easy to start and stop, but this module is here to do it from JavaScript itself.

// Start a disposable node, and get access to the api
// print the node id, and kill the temporary daemon

// IPFS_PATH will point to /tmp/ipfs_***** and will be
// cleaned up when the process exits.

var ipfsd = require('ipfsd-ctl')

ipfsd.disposableApi(function (err, ipfs) {
  ipfs.id(function (err, id) {
    console.log(id)
    process.exit()
  })
})

If you need want to use an existing ipfs installation you can set $IPFS_EXEC=/path/to/ipfs to ensure it uses that.

For more details see https://ipfs.github.io/js-ipfsd-ctl/.

Contribute

Feel free to join in. All welcome. Open an issue!

This repository falls under the IPFS Code of Conduct.

License

MIT