start-ipfs-daemon v1.2.1

start-ipfs-daemon

Spawn an IPFS daemon from Node.js

Install

npm i start-ipfs-daemon

Usage

First install your favourite go-ipfs daemon, you could npm install go-ipfs-dep, brew install ipfs or whatever.

const startDaemon = require('start-ipfs-daemon')

const daemon = await startDaemon({
  // The path to your IPFS executable.
  // default:
  //   node_modules/go-ipfs-dep/go-ipfs/ipfs (preferred)
  //   node_modules/ipfs/src/cli/bin.js
  // (required if neither of ipfs/go-ipfs-dep installed)
  execPath: '/usr/local/bin/ipfs',
  // Path to your IPFS repo (default shown)
  // Created if not exists
  ipfsPath: '~/.ipfs',
  // Config to merge with your current config at ~/.ipfs/config (optional)
  config: { /* IPFS config */ },
  // Additional CLI arguments to pass to the `ipfs daemon` command
  args: ['--enable-pubsub-experiment']
  // Options for deepmerge (defaults shown)
  // see https://www.npmjs.com/package/deepmerge#arraymerge
  mergeOptions: {
    arrayMerge: function overwrite (_, sourceArray) { return sourceArray }
  },
  // Pipe stdout and stderr to these writeable streams if provided
  stdout: process.stdout,
  stderr: process.stderr
})

// Your go IPFS Daemon is now READY to use

// Your daemon configuration
console.log(daemon.config)

// Maybe you wanna talk to it over the HTTP API?
const IpfsApi = require('ipfs-api')
const ipfs = IpfsApi(daemon.config.Addresses.API)

// Node.js child process
// https://nodejs.org/api/child_process.html#child_process_class_childprocess
// ...enhanced by execa
// https://www.npmjs.com/package/execa
await daemon.process

Contribute

Feel free to dive in! Open an issue or submit PRs.

License

MIT © Alan Shaw