CLI Tools with Node

Learn how you can easily create your own CLI (Command Line Interface) tool with Node.js.

Transcript

1. CLI Tools with Node @hmschreiner
2. root@hmschreiner : $ whoami # Henrique Schreiner Software Developer at e-Core @hmschreiner linkedin.com/in/HenriqueSchreiner e-core.com/pt/carreiras
3. # Creating the Project
4. root@hmschreiner : ~/my-tool-folder $ npm init name: file-search version: 1.0.0 description: My CLI tool to search files entry point: index.js test command: git repository: keywords: author: Henrique Schreiner license: (ISC)
5. { "name": "file-search", "version": "1.0.0", "description": "My CLI tool to search files", "main": "index.js", "author": "Henrique Schreiner", "license": "ISC" } Is this ok? (yes) root@hmschreiner : ~/my-tool-folder $ npm init
6. # Editing package.json
7. { "name": "file-search", "version": "1.0.0", "description": "My CLI tool to search files", "main": "index.js", "author": "Henrique Schreiner", "license": "ISC", }
8. { "name": "file-search", "version": "1.0.0", "description": "My CLI tool to search files", "author": "Henrique Schreiner", "license": "ISC", "preferGlobal": true, "bin": { "file-search": "index.js" } }
9. # Creating the Script
10. root@hmschreiner : ~/my-tool-folder $ vim index.js #!/usr/bin/env node --harmony 'use strict'; console.log('This is the file-search script.');
11. # Installing the Script
12. root@hmschreiner : ~/my-tool-folder $ npm link - Install the script on your system - Creates a symlink to your project so that you can run the project whilst working on it - No need to keep reinstalling it over and over again
13. root@hmschreiner : ~ $ file-search This is the file-search script.
14. # Processing Arguments
15. root@hmschreiner : ~/my-tool-folder $ vim index.js #!/usr/bin/env node --harmony 'use strict'; console.log(process.argv);
16. root@hmschreiner : ~ $ file-search hello [ 'node', '/Users/hmschreiner/bin/file-search', 'hello' ]
17. root@hmschreiner : ~/my-tool-folder $ vim index.js #!/usr/bin/env node --harmony 'use strict'; let inputArgs = process.argv.slice(2); let searchPattern = inputArgs[0];
18. # Searching for Files
19. root@hmschreiner : ~/my-tool-folder $ vim index.js #!/usr/bin/env node --harmony 'use strict'; const exec = require('child_process').exec; let inputArgs = process.argv.slice(2); let searchPattern = inputArgs[0]; exec(`ls -a | grep ${searchPattern}`, (err, stdout, stderr) => { console.log(stdout); });
20. root@hmschreiner : ~/my-tool-folder $ file-search package package.json
21. # Next Steps
22. root@hmschreiner : ~/my-tool-folder $ npm publish - Ensure a good, well written README file - Decide on an initial version number (e.g. 1.0.0) - If you’ve not registered on npm...
23. root@hmschreiner : ~/my-tool-folder $ npm adduser - Follow the prompts to set up and authenticate yourself - Once published, users can then install your module
24. root@hmschreiner : ~ $ npm install --g file-search /usr/local/lib └─┬ file-search@1.0.0 ...
25. # Thank You!