ipfs/src/cli/commands/cat.js

JavaScript implementation of the IPFS specification

'use strict'

module.exports = {
  command: 'cat <ipfsPath>',

  describe: 'Fetch and cat an IPFS path referencing a file',

  builder: {
    offset: {
      alias: 'o',
      type: 'integer',
      describe: 'Byte offset to begin reading from'
    },
    length: {
      alias: ['n', 'count'],
      type: 'integer',
      describe: 'Maximum number of bytes to read'
    }
  },

  handler ({ getIpfs, ipfsPath, offset, length, resolve }) {
    resolve((async () => {
      const ipfs = await getIpfs()

      return new Promise((resolve, reject) => {
        const stream = ipfs.catReadableStream(ipfsPath, { offset, length })

        stream.on('error', reject)
        stream.on('end', resolve)

        stream.pipe(process.stdout)
      })
    })())
  }
}