ipfs/src/cli/commands/pin/ls.js

JavaScript implementation of the IPFS specification

'use strict'

const multibase = require('multibase')
const { print } = require('../../utils')
const { cidToString } = require('../../../utils/cid')

module.exports = {
  // bracket syntax with '...' tells yargs to optionally accept a list
  command: 'ls [ipfsPath...]',

  describe: 'List objects pinned to local storage.',

  builder: {
    type: {
      type: 'string',
      alias: 't',
      default: 'all',
      choices: ['direct', 'indirect', 'recursive', 'all'],
      describe: 'The type of pinned keys to list.'
    },
    quiet: {
      type: 'boolean',
      alias: 'q',
      default: false,
      describe: 'Write just hashes of objects.'
    },
    'cid-base': {
      describe: 'Number base to display CIDs in.',
      type: 'string',
      choices: multibase.names
    }
  },

  handler: ({ getIpfs, ipfsPath, type, quiet, cidBase, resolve }) => {
    resolve((async () => {
      const paths = ipfsPath
      const ipfs = await getIpfs()
      const results = await ipfs.pin.ls(paths, { type })
      results.forEach((res) => {
        let line = cidToString(res.hash, { base: cidBase })
        if (!quiet) {
          line += ` ${res.type}`
        }
        print(line)
      })
    })())
  }
}