https://github.com/lenneTech/cli-starter
A starter project for CLI with @lenne.tech/cli-plugin-helper and @lenne.tech/npm-package-helper
https://github.com/lenneTech/cli-starter
Last synced: 7 months ago
JSON representation
A starter project for CLI with @lenne.tech/cli-plugin-helper and @lenne.tech/npm-package-helper
- Host: GitHub
- URL: https://github.com/lenneTech/cli-starter
- Owner: lenneTech
- License: mit
- Created: 2019-09-03T20:27:20.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T20:51:15.000Z (over 2 years ago)
- Last Synced: 2024-06-11T03:34:31.125Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 1020 KB
- Stars: 14
- Watchers: 2
- Forks: 1
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CLI Starter
A CLI Starter for your next [Gluegun](https://infinitered.github.io/gluegun/#/) CLI project.
[](/LICENSE) [](https://circleci.com/gh/lenneTech/cli-starter/tree/master)
[](https://david-dm.org/lenneTech/cli-starter) [](https://david-dm.org/lenneTech/cli-starter?type=dev)
## Initialize CLI
Via lenne.Tech CLI:
```shell
$ npm install -g @lenne.tech/cli
$ lt cli create
```
Via GitHub:
```shell
$ git clone https://github.com/lenneTech/cli-starter.git
$ cd
$ npm i
$ npm run rename
```
Via ZIP:
1. Download Starter: https://github.com/lenneTech/cli-starter/archive/master.zip
2. Unpack ZIP
3. Run `npm i && npm run rename ` in project directory
## Customizing your CLI
Check out the documentation at https://github.com/infinitered/gluegun/tree/master/docs.
## Publishing to NPM
To package your CLI up for NPM, do this:
```shell
$ npm login
$ npm whoami
$ npm lint
$ npm test
(if typescript, run `npm run build` here)
$ npm publish
(if you are publish a public package for the first time: npm publish --access public)
```
# License
MIT - see LICENSE