Merge pull request #390 from ipfs/better-cli

Refactor cli to use yargs

package.json

@@ -82,22 +82,26 @@
     "libp2p-ipfs-browser": "^0.12.1",
     "lodash.get": "^4.4.0",
     "lodash.set": "^4.3.0",
+    "lodash.sortby": "^4.6.1",
     "mafmt": "^2.1.1",
-    "multihashes": "^0.2.2",
+    "map-limit": "0.0.1",
     "multiaddr": "^2.0.2",
+    "multihashes": "^0.2.2",
     "path-exists": "^3.0.0",
     "peer-book": "^0.3.0",
     "peer-id": "^0.7.0",
     "peer-info": "^0.7.0",
     "promisify-es6": "^1.0.1",
+    "read-pkg-up": "^1.0.1",
     "readable-stream": "1.1.13",
-    "ronin": "^0.3.11",
     "run-parallel": "^1.1.6",
     "run-parallel-limit": "^1.0.3",
     "run-series": "^1.1.4",
     "run-waterfall": "^1.1.3",
     "temp": "^0.8.3",
-    "through2": "^2.0.1"
+    "through2": "^2.0.1",
+    "update-notifier": "^1.0.2",
+    "yargs": "^4.8.1"
   },
   "contributors": [
     "Andrew de Andrade <andrew@deandrade.com.br>",

src/cli/bin.js

@@ -2,12 +2,20 @@
 
 'use strict'
 
-const ronin = require('ronin')
+const yargs = require('yargs')
+const updateNotifier = require('update-notifier')
+const readPkgUp = require('read-pkg-up')
 
-const cli = ronin(__dirname)
+const pkg = readPkgUp.sync().pkg
+updateNotifier({
+  pkg,
+  updateCheckInterval: 1000 * 60 * 60 * 24 * 7 // 1 week
+}).notify()
 
-cli.run()
-
-// cli.autoupdate(function () {
-//   cli.run()
-// })
+yargs
+  .commandDir('commands')
+  .demand(1)
+  .help()
+  .strict()
+  .completion()
+  .argv

src/cli/commands/bitswap.js

@@ -0,0 +1,15 @@
+'use strict'
+
+module.exports = {
+  command: 'bitswap',
+
+  description: 'A set of commands to manipulate the bitswap agent.',
+
+  builder (yargs) {
+    return yargs
+      .commandDir('bitswap')
+  },
+
+  handler (argv) {
+  }
+}

src/cli/commands/bitswap/stat.js

@@ -1,15 +1,15 @@
 'use strict'
 
-const Command = require('ronin').Command
 const utils = require('../../utils')
 
-module.exports = Command.extend({
-  desc: 'Show some diagnostic information on the bitswap agent.',
+module.exports = {
+  command: 'stat',
 
-  options: {
-  },
+  describe: 'Show some diagnostic information on the bitswap agent.',
 
-  run: () => {
+  builder: {},
+
+  handler () {
     utils.getIPFS((err, ipfs) => {
       if (err) {
         throw err
@@ -35,4 +35,4 @@ bitswap status
       })
     })
   }
-})
+}

src/cli/commands/bitswap/unwant.js

@@ -1,18 +1,13 @@
 'use strict'
 
-const Command = require('ronin').Command
 const utils = require('../../utils')
 
-module.exports = Command.extend({
-  desc: 'Remove a given block from your wantlist.',
+module.exports = {
+  command: 'unwant <key>',
 
-  options: {
-    key: {
-      required: true
-    }
-  },
+  describe: 'Remove a given block from your wantlist.',
 
-  run: (key) => {
+  handler (argv) {
     utils.getIPFS((err, ipfs) => {
       if (err) {
         throw err
@@ -21,4 +16,4 @@ module.exports = Command.extend({
       throw new Error('Not implemented yet')
     })
   }
-})
+}

src/cli/commands/bitswap/wantlist.js

@@ -1,15 +1,22 @@
 'use strict'
 
-const Command = require('ronin').Command
 const utils = require('../../utils')
 
-module.exports = Command.extend({
-  desc: 'Print out all blocks currently on the bitswap wantlist for the local peer.',
+module.exports = {
+  command: 'wantlist',
 
-  options: {
+  describe: 'Print out all blocks currently on the bitswap wantlist for the local peer.',
+
+  builder: {
+    peer: {
+      alias: 'p',
+      describe: 'Specify which peer to show wantlist for.',
+      type: 'string'
+    }
   },
 
-  run: () => {
+  handler (argv) {
+    // TODO: handle argv.peer
     utils.getIPFS((err, ipfs) => {
       if (err) {
         throw err
@@ -23,4 +30,4 @@ module.exports = Command.extend({
       })
     })
   }
-})
+}

src/cli/commands/block.js

@@ -0,0 +1,15 @@
+'use strict'
+
+module.exports = {
+  command: 'block',
+
+  description: 'Manipulate raw IPFS blocks.',
+
+  builder (yargs) {
+    return yargs
+      .commandDir('block')
+  },
+
+  handler (argv) {
+  }
+}

src/cli/commands/block/get.js

@@ -1,30 +1,27 @@
 'use strict'
 
-const Command = require('ronin').Command
 const utils = require('../../utils')
 const bs58 = require('bs58')
 const debug = require('debug')
 const log = debug('cli:block')
 log.error = debug('cli:block:error')
 
-module.exports = Command.extend({
-  desc: 'Get a raw IPFS block',
+module.exports = {
+  command: 'get <key>',
 
-  options: {},
+  describe: 'Get a raw IPFS block',
 
-  run: (key) => {
-    if (!key) {
-      throw new Error("Argument 'key' is required")
-    }
+  builder: {},
 
+  handler (argv) {
     utils.getIPFS((err, ipfs) => {
       if (err) {
         throw err
       }
 
       const mh = utils.isDaemonOn()
-        ? key
-        : new Buffer(bs58.decode(key))
+        ? argv.key
+        : new Buffer(bs58.decode(argv.key))
 
       ipfs.block.get(mh, (err, block) => {
         if (err) {
@@ -40,4 +37,4 @@ module.exports = Command.extend({
       })
     })
   }
-})
+}

src/cli/commands/block/put.js

@@ -1,6 +1,5 @@
 'use strict'
 
-const Command = require('ronin').Command
 const utils = require('../../utils')
 const bs58 = require('bs58')
 const bl = require('bl')
@@ -38,14 +37,16 @@ function addBlock (buf) {
   })
 }
 
-module.exports = Command.extend({
-  desc: 'Stores input as an IPFS block',
+module.exports = {
+  command: 'put [data]',
 
-  options: {},
+  describe: 'Stores input as an IPFS block',
 
-  run: (filePath) => {
-    if (filePath) {
-      return addBlock(fs.readFileSync(filePath))
+  builder: {},
+
+  handler (argv) {
+    if (argv.data) {
+      return addBlock(fs.readFileSync(argv.data))
     }
 
     process.stdin.pipe(bl((err, input) => {
@@ -56,4 +57,4 @@ module.exports = Command.extend({
       addBlock(input)
     }))
   }
-})
+}

src/cli/commands/block/rm.js

@@ -1,22 +1,19 @@
 'use strict'
 
-const Command = require('ronin').Command
 const utils = require('../../utils')
 const bs58 = require('bs58')
 const debug = require('debug')
 const log = debug('cli:block')
 log.error = debug('cli:block:error')
 
-module.exports = Command.extend({
-  desc: 'Remove a raw IPFS block',
+module.exports = {
+  command: 'rm <key>',
 
-  options: {},
+  describe: 'Remove a raw IPFS block',
 
-  run: (key) => {
-    if (!key) {
-      throw new Error("Argument 'key' is required")
-    }
+  builder: {},
 
+  handler (argv) {
     utils.getIPFS((err, ipfs) => {
       if (err) {
         throw err
@@ -27,15 +24,15 @@ module.exports = Command.extend({
         throw new Error('rm block with daemon running is not yet implemented')
       }
 
-      const mh = new Buffer(bs58.decode(key))
+      const mh = new Buffer(bs58.decode(argv.key))
 
       ipfs.block.del(mh, (err) => {
         if (err) {
           throw err
         }
 
-        console.log('removed', key)
+        console.log('removed', argv.key)
       })
     })
   }
-})
+}

src/cli/commands/block/stat.js

@@ -1,30 +1,27 @@
 'use strict'
 
-const Command = require('ronin').Command
 const utils = require('../../utils')
 const bs58 = require('bs58')
 const debug = require('debug')
 const log = debug('cli:block')
 log.error = debug('cli:block:error')
 
-module.exports = Command.extend({
-  desc: 'Print information of a raw IPFS block',
+module.exports = {
+  command: 'stat <key>',
 
-  options: {},
+  describe: 'Print information of a raw IPFS block',
 
-  run: (key) => {
-    if (!key) {
-      throw new Error("Argument 'key' is required")
-    }
+  builder: {},
 
+  handler (argv) {
     utils.getIPFS((err, ipfs) => {
       if (err) {
         throw err
       }
 
       const mh = utils.isDaemonOn()
-        ? key
-        : new Buffer(bs58.decode(key))
+        ? argv.key
+        : new Buffer(bs58.decode(argv.key))
 
       ipfs.block.stat(mh, (err, block) => {
         if (err) {
@@ -41,4 +38,4 @@ module.exports = Command.extend({
       })
     })
   }
-})
+}

src/cli/commands/bootstrap.js

@@ -0,0 +1,15 @@
+'use strict'
+
+module.exports = {
+  command: 'bootstrap',
+
+  description: 'Show or edit the list of bootstrap peers.',
+
+  builder (yargs) {
+    return yargs
+      .commandDir('bootstrap')
+  },
+
+  handler (argv) {
+  }
+}