Skip to content

Commit 279a39f

Browse files
committed
📦 NEW: First commit
1 parent 086bb62 commit 279a39f

File tree

11 files changed

+165
-38
lines changed

11 files changed

+165
-38
lines changed

.github/create-node-cli.jpg

41.6 KB
Loading

.github/funding.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
custom:
2+
[
3+
'https://NodeCLI.com',
4+
'https://VSCode.pro',
5+
'https://github.com/ahmadawais/sponsor',
6+
]

.history/authorEmail.json

Lines changed: 0 additions & 8 deletions
This file was deleted.

.history/authorName.json

Lines changed: 0 additions & 8 deletions
This file was deleted.

.history/authorUrl.json

Lines changed: 0 additions & 8 deletions
This file was deleted.

package.json

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"description": "CLI to create Node.js CLIs.",
44
"version": "0.0.3",
55
"bin": {
6-
"create-nodejs-cli": "index.js",
6+
"create-node-cli": "index.js",
77
"ncli": "index.js"
88
},
99
"repository": "ahmadawais/create-node-cli",
@@ -12,6 +12,19 @@
1212
"email": "[email protected]",
1313
"url": "https://twitter.com/MrAhmadAwais/"
1414
},
15+
"files": [
16+
"index.js",
17+
"utils"
18+
],
19+
"keywords": [
20+
"create-node-cli",
21+
"Create Node.js CLI",
22+
"Build Node CLI",
23+
"node cli",
24+
"nodejs",
25+
"Awais",
26+
"Ahmad Awais"
27+
],
1528
"dependencies": {
1629
"await-to-js": "^2.1.1",
1730
"chalk": "^4.1.0",

readme.md

Lines changed: 139 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,141 @@
1-
# create-nodejs-cli
1+
[![Part of NodeCLI.com course](https://raw.githubusercontent.com/ahmadawais/create-node-cli/master/.github/create-node-cli.jpg)][n]
22

3-
> CLI to create Node.js CLIs.
3+
# create-node-cli
44

5-
**Documentation is work in progress.**
5+
[![Learn to build Node.js CLI](https://img.shields.io/badge/-NodeCLI.com%20%E2%86%92-gray.svg?colorB=488640&style=flat)][n] [![DOWNLOADS](https://img.shields.io/npm/dt/create-node-cli?label=DOWNLOADS%20%20❯&colorA=6A788D&colorB=6A788D&style=flat)](https://www.npmjs.com/package/create-node-cli)
6+
[![Follow @MrAhmadAwais on Twitter](https://img.shields.io/badge/FOLLOW%20@MRAHMADAWAIS%20%E2%86%92-gray.svg?colorA=6A788D&colorB=6A788D&style=flat)](https://twitter.com/mrahmadawais/)
7+
8+
> 📟 CLI to create new Node.js CLI applications.
9+
10+
- 📟 Generate a new Node.js CLI application in a minute
11+
12+
<br>
13+
14+
[![📟](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/install.png)](./../../)
15+
16+
## Install
17+
18+
```sh
19+
npm install -g create-node-cli
20+
21+
# OR.
22+
npx create-node-cli
23+
```
24+
25+
<br>
26+
27+
[![⚙️](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/usage.png)](./../../)
28+
29+
## Usage
30+
31+
1. Run the CLI using
32+
33+
```sh
34+
npx create-node-cli
35+
36+
# OR for global install
37+
create-node-cli
38+
# OR alias for global install
39+
ncli
40+
```
41+
42+
_Then answer the following questions to generate a Node.js CLI._
43+
44+
```sh
45+
CLI name?
46+
CLI command?
47+
CLI description?
48+
CLI version?
49+
CLI license?
50+
CLI author name?
51+
CLI author email?
52+
CLI author URL?
53+
````
54+
55+
#### BASIC USAGE
56+
57+
```sh
58+
create-node-cli <command> [option]
59+
```
60+
61+
#### COMMANDS
62+
63+
```sh
64+
help Print help info
65+
```
66+
67+
#### OPTIONS
68+
69+
```sh
70+
-c, --clear Clear the console Default: true
71+
-d, --debug Print debug info Default: false
72+
-v, --version Print CLI version Default: false
73+
```
74+
75+
<br>
76+
77+
[![📝](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/log.png)](changelog.md)
78+
79+
## Changelog
80+
81+
[❯ Read the changelog here →](changelog.md)
82+
83+
<br>
84+
85+
<small>**KEY**: `📦 NEW`, `👌 IMPROVE`, `🐛 FIX`, `📖 DOC`, `🚀 RELEASE`, and `🤖 TEST`
86+
87+
> _I use [Emoji-log](https://github.com/ahmadawais/Emoji-Log), you should try it and simplify your git commits._
88+
89+
</small>
90+
91+
<br>
92+
93+
[![📃](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/license.png)](./../../)
94+
95+
## License & Conduct
96+
97+
- MIT © [Ahmad Awais](https://twitter.com/MrAhmadAwais/)
98+
- Thanks Liran Tal for the npm pkg name
99+
- [Code of Conduct](code-of-conduct.md)
100+
101+
<br>
102+
103+
[![🙌](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/connect.png)](./../../)
104+
105+
## Connect
106+
107+
<div align="left">
108+
<p><a href="https://github.com/ahmadawais"><img alt="GitHub @AhmadAwais" align="center" src="https://img.shields.io/badge/GITHUB-gray.svg?colorB=6cc644&colorA=6cc644&style=flat" /></a>&nbsp;<small><strong>(follow)</strong> To stay up to date on free & open-source software</small></p>
109+
<p><a href="https://twitter.com/MrAhmadAwais/"><img alt="Twitter @MrAhmadAwais" align="center" src="https://img.shields.io/badge/TWITTER-gray.svg?colorB=1da1f2&colorA=1da1f2&style=flat" /></a>&nbsp;<small><strong>(follow)</strong> To get #OneDevMinute daily hot tips & trolls</small></p>
110+
<p><a href="https://www.youtube.com/AhmadAwais"><img alt="YouTube AhmadAwais" align="center" src="https://img.shields.io/badge/YOUTUBE-gray.svg?colorB=ff0000&colorA=ff0000&style=flat" /></a>&nbsp;<small><strong>(subscribe)</strong> To tech talks & #OneDevMinute videos</small></p>
111+
<p><a href="https://AhmadAwais.com/"><img alt="Blog: AhmadAwais.com" align="center" src="https://img.shields.io/badge/MY%20BLOG-gray.svg?colorB=4D2AFF&colorA=4D2AFF&style=flat" /></a>&nbsp;<small><strong>(read)</strong> In-depth & long form technical articles</small></p>
112+
<p><a href="https://www.linkedin.com/in/MrAhmadAwais/"><img alt="LinkedIn @MrAhmadAwais" align="center" src="https://img.shields.io/badge/LINKEDIN-gray.svg?colorB=0077b5&colorA=0077b5&style=flat" /></a>&nbsp;<small><strong>(connect)</strong> On the LinkedIn profile y'all</small></p>
113+
</div>
114+
115+
<br>
116+
117+
[![👌](https://raw.githubusercontent.com/ahmadawais/stuff/master/images/git/sponsor.png)](./../../)
118+
119+
## Sponsor
120+
121+
Me ([Ahmad Awais](https://twitter.com/mrahmadawais/)) and my incredible wife ([Maedah Batool](https://twitter.com/MaedahBatool/)) are two engineers who fell in love with open source and then with each other. You can read more [about me here](https://ahmadawais.com/about). If you or your company use any of my projects or like what I’m doing then consider backing me. I'm in this for the long run. An open-source developer advocate.
122+
123+
- 🌟 **$9.99/month (recommended)** ❯ [Two cups of Caffè latte (coffee) every month →](https://pay.paddle.com/checkout/540217)
124+
- 🚀 **$99.99 (one-time sponsor)** ❯ [Support an hour of open-source code →](https://pay.paddle.com/checkout/515568)
125+
- 🔰 **$49.99 (one-time sponsor)** ❯ [Support an hour of maintenance →](https://pay.paddle.com/checkout/527253)
126+
- ☕️ **$9.99 (one-time sponsor)** ❯ [Lunch/coffee →](https://pay.paddle.com/checkout/527254)
127+
128+
<br>
129+
130+
Or you can back me by checking out my super fun video course. After building hundreds of developer automation tools used by millions of developers, I am sharing exactly how you can do it yourself with minimum effective effort. Learn to build Node.js & JavaScript based CLI (Command Line Interface) apps. Automate the grunt work, do more in less time, impress your manager, and help the community.
131+
→ I'm sharing it all in this online video course. <a href="https://nodecli.com/?utm_source=FOSS&utm_medium=FOSS&utm_campaign=create-node-cli" target="_blank">Node CLI Automation
132+
without wasting a 1,000 hours</a> →</p>
133+
134+
[![NodeCLI.com](https://raw.githubusercontent.com/ahmadawais/stuff/master/nodecli/featured.jpg)[n]
135+
136+
<br>
137+
138+
[![Node CLI](https://img.shields.io/badge/-NodeCLI.com%20%E2%86%92-gray.svg?colorB=488640&style=flat)](https://nodecli.com/?utm_source=FOSS&utm_medium=FOSS&utm_campaign=create-node-cli)
139+
[![Ahmad on Twitter](https://img.shields.io/twitter/follow/mrahmadawais.svg?style=social&label=Follow%20@MrAhmadAwais)](https://twitter.com/mrahmadawais/)
140+
141+
[n]: https://nodecli.com/?utm_source=FOSS&utm_medium=FOSS&utm_campaign=create-node-cli

template/utils/cli.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,7 @@ const flags = {
2222
};
2323

2424
const commands = {
25-
help: {
26-
description: `Print help info`
27-
}
25+
help: { desc: `Print help info` }
2826
};
2927

3028
const helpText = meowHelp({

todo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# create-nodejs-cli
1+
# create-node-cli
22

33
- `template`
44
- Dynamic template `{{var}}`

utils/cli.js

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,11 @@ const flags = {
2222
};
2323

2424
const commands = {
25-
help: {
26-
description: `Print help info`
27-
}
25+
help: { desc: `Print help info` }
2826
};
2927

3028
const helpText = meowHelp({
31-
name: `create-nodejs-file`,
29+
name: `create-node-cli`,
3230
flags,
3331
commands
3432
});

utils/init.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ const unhandled = require('cli-handle-unhandled');
55
module.exports = ({ clear = true }) => {
66
unhandled();
77
welcome({
8-
title: 'create-nodejs-cli',
9-
tagLine: 'by Awais.dev',
8+
title: `create-node-cli`,
9+
tagLine: `by Awais.dev`,
1010
description: pkg.description,
1111
version: pkg.version,
1212
bgColor: '#6cc24a',

0 commit comments

Comments
 (0)