Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emosheeep/cli-template
Modern Node.js Command Line Tool Project Template.
https://github.com/emosheeep/cli-template
changesets cli commitlint esbuild eslint husky lint-staged nodejs pnpm prettier tsup typescript zx
Last synced: 2 days ago
JSON representation
Modern Node.js Command Line Tool Project Template.
- Host: GitHub
- URL: https://github.com/emosheeep/cli-template
- Owner: emosheeep
- License: mit
- Created: 2024-01-20T12:19:41.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-02-29T16:39:04.000Z (9 months ago)
- Last Synced: 2024-02-29T17:44:57.232Z (9 months ago)
- Topics: changesets, cli, commitlint, esbuild, eslint, husky, lint-staged, nodejs, pnpm, prettier, tsup, typescript, zx
- Language: JavaScript
- Homepage:
- Size: 148 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Cli Template
This is a modern Command-Line-Tool template repository base on Node.js. You can quickly set up your cli apps with this project.
## Quick Start
```shell
# development
pnpm install
pnpm watch
pnpm ln -g # link your command globally so that you can debug easier.
# execute your global-linked command.
command-name -h
# publish your package to npm.
pnpm changeset
pnpm versions
# manually trigger publish action(.github/workflows/publish.yml).
```
## Attention
Please read the documentations of these useful tools before developing, which avoids making repetitive wheels and helps you building your cli apps.
- [zx](https://github.com/google/zx) - Execute shell command conveniently in Node.js workflow.
- [commander](https://github.com/tj/commander.js) - Node.js command-line interfaces.
- [tsup](https://github.com/egoist/tsup) - A simple and fast builder based on esbuild.
- [changesets](https://github.com/changesets/changesets) - A way to manage your versioning and changelogs.
- and so do the other tools you'll develop with, please read the docs by yourself.
Here are some [command-line-apps](https://github.com/sindresorhus/awesome-nodejs?tab=readme-ov-file#command-line-apps) and [command-line-utilities](https://github.com/sindresorhus/awesome-nodejs?tab=readme-ov-file#command-line-utilities) you probably use, which are really wonderful.
## Contribution
PR welcome if you have any constructive suggestions. Please polish your code and describe you commit msg concisely and detailedly.