https://github.com/vincecao/node-cli-starter
https://github.com/vincecao/node-cli-starter
commanderjs nodejs
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/vincecao/node-cli-starter
- Owner: vincecao
- Created: 2025-03-13T04:51:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-13T05:02:50.000Z (over 1 year ago)
- Last Synced: 2025-03-13T06:18:39.549Z (over 1 year ago)
- Topics: commanderjs, nodejs
- Language: JavaScript
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node CLI Starter
A simple command-line interface tool template for greeting users, with [commander](https://github.com/tj/commander.js) and typescript
## Development
```bash
pnpm i
pnpm run dev hello [name]
pnpm run test
```
## Installation
Install the package globally using npm, make sure build before install:
```bash
pnpm run build
npm install -g .
```
## Uninstallation
```bash
npm remove -g node-cli-starter
```
## Usage
### Basic Command
To greet someone:
```bash
mycli hello [name]
```
Example:
```bash
mycli hello John
```
### Language Option
You can specify the greeting language using the `-l` or `--language` option. Currently supports:
- `en` (default) - English
- `es` - Spanish
Example:
```bash
mycli hello Maria --language es
```
## Commands
| Command | Description | Options |
| -------------- | --------------------------- | ----------------------- |
| `hello ` | Greets the specified person | `-l, --language ` |
## Version
Current version: 1.0.0
## License
[MIT](LICENSE)