[Node.js] Setup a Node.js CLI

2022-09-02 22:35:04 阅读：210 来源： 互联网

Creating a CLI in Node.js just takes a extra step or two because they are really just an ordinary Node.js app wrapped behind a bin command. For this exercise, we'll create a CLI that opens a random reddit post in our browser. To start, we'll create a new folder and make it a package with npm init.

Once inside that folder, create a file reddit.mjs:

// reddit.mjs
#! /usr/bin/env node

console.log('hello from your CLI')

The fist line on that file is called a shabang or hashbang. It's needed to tell the machine where the interpreter is located that is needed to execute this file. For us, that will be Node.js.

Next we need to tell Node.js what the name of our CLI is so when can actually use it in our terminal. Just have to add a section to our package.json:

"bin": {
  "reddit": "./reddit.mjs"
}

Once installed, this package will have it's bin command installed into your machine's bin folder allowing us to use the reddit command.

Lastly, we must install our own package locally so we can test out the CLI. We could just execute the file with the node runtime, but we want to see the CLI actually work.

npm install -g

We can simply instll with no args which tells npm to install the current director. The -g flag means we want to globally install this package vs in a local node_modules.

You should now be able to run reddit and see your log print.

标签：Node,bin,reddit,CLI,Setup,js,our
来源： https://www.cnblogs.com/Answer1215/p/16651524.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

[Node.js] Setup a Node.js CLI