You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -63,16 +64,27 @@ You can use npx, example: `npx @ptkdev/node-cli-boilerplate`
63
64
64
65
1. Clone this repository or download [nightly](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/archive/nightly.zip), [beta](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/archive/beta.zip) or [stable](https://github.com/ptkdev-boilerplate/node-cli-boilerplate/archive/main.zip).
65
66
2. Run `npm install`
66
-
3. Run `npm run build`
67
-
4. Run `npm run link`
68
-
5. Run `node-cli-boilerplate` anywhere for execute command line tool
67
+
3. Run `npm run dev` for watch mode
69
68
70
-
or run `npm run dev` for watch mode.
69
+
If you want to try cli locally:
70
+
71
+
4. Run `npm run build`
72
+
5. Run `npm link` (on unix/mac use `sudo npm link`)
73
+
6. Run `node-cli-boilerplate` anywhere for execute command line tool
74
+
75
+
For uninstall it run `npm unlink` (on unix/mac use `sudo npm unlink`)
71
76
72
77
#### 💾 Setup Project
73
78
74
79
If you want replace all strings (example: package name, author, urls, etc...) in markdown file, source files and others files of this project you need edit `setup.json` with correct values and run `npm run setup`.
75
80
81
+
#### 🚀 Deploy
82
+
83
+
For create npm package:
84
+
85
+
- Run `npm run release`
86
+
- Run `npm publish`
87
+
76
88
## 📚 Documentation
77
89
78
90
Run `npm run docs`
@@ -121,7 +133,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
0 commit comments