# typescript-npm-cli-template

> A template for creating npm CLI tools using TypeScript and VSCode

Latest version **1.0.4** (published 2022-06-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install typescript-npm-cli-template
pnpm add typescript-npm-cli-template
yarn add typescript-npm-cli-template
bun add typescript-npm-cli-template
```

Provides the command `my-command`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2022-06-10 |
| First published | 2021-06-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=12.0 |
| Dependencies | 1 |
| Unpacked size | 10.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 22 |
| Author | Ryan Sonshine |
| Maintainers | ryansonshine |
| Keywords | boilerplate, cli, template, typescript, vscode, jest, husky, commitizen, semantic-release, codecov |

## Links

- npm: https://www.npmjs.com/package/typescript-npm-cli-template
- Repository: https://github.com/ryansonshine/typescript-npm-cli-template
- Homepage: https://github.com/ryansonshine/typescript-npm-cli-template#readme
- Issues: https://github.com/ryansonshine/typescript-npm-cli-template/issues
- npm.io page: https://npm.io/package/typescript-npm-cli-template

## Dependencies (1)

- [commander](https://npm.io/package/commander.md) ^7.2.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2022-06-10
- 1.0.3 — 2021-09-17
- 1.0.2 — 2021-09-13
- 1.0.1 — 2021-06-24
- 1.0.0 — 2021-06-11

## README

# typescript-npm-cli-template

> Boilerplate to kickstart creating a Node.js command-line tool

Inspired by [node-cli-boilerplate](https://github.com/sindresorhus/node-cli-boilerplate)

## Getting started

**Click the "Use this template" button.**

Alternatively, create a new directory and then run:

```bash
curl -fsSL https://github.com/ryansonshine/typescript-npm-cli-template/archive/main.tar.gz | tar -xz --strip-components=1
```

**Remove everything from here and above**

---

# my-cli-name

[![npm package][npm-img]][npm-url]
[![Build Status][build-img]][build-url]
[![Downloads][downloads-img]][downloads-url]
[![Issues][issues-img]][issues-url]
[![Code Coverage][codecov-img]][codecov-url]
[![Commitizen Friendly][commitizen-img]][commitizen-url]
[![Semantic Release][semantic-release-img]][semantic-release-url]

> My awesome command-line tool

## Install

```bash
npm install my-cli-name
```

## Usage

```bash
Usage: my-command [options]

Options:
  -V, --version            output the version number
  -d, --debug              enables verbose logging (default: false)
  -v, --verbose            enables verbose logging (default: false)

Examples:

  $ my-command --version
  1.0.0
```

[build-img]:https://github.com/ryansonshine/typescript-npm-cli-template/actions/workflows/release.yml/badge.svg
[build-url]:https://github.com/ryansonshine/typescript-npm-cli-template/actions/workflows/release.yml
[downloads-img]:https://img.shields.io/npm/dt/typescript-npm-cli-template
[downloads-url]:https://www.npmtrends.com/typescript-npm-cli-template
[npm-img]:https://img.shields.io/npm/v/typescript-npm-cli-template
[npm-url]:https://www.npmjs.com/package/typescript-npm-cli-template
[issues-img]:https://img.shields.io/github/issues/ryansonshine/typescript-npm-cli-template
[issues-url]:https://github.com/ryansonshine/typescript-npm-cli-template/issues
[codecov-img]:https://codecov.io/gh/ryansonshine/typescript-npm-cli-template/branch/main/graph/badge.svg
[codecov-url]:https://codecov.io/gh/ryansonshine/typescript-npm-cli-template
[semantic-release-img]:https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-release-url]:https://github.com/semantic-release/semantic-release
[commitizen-img]:https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[commitizen-url]:http://commitizen.github.io/cz-cli/

---
_Source: https://npm.io/package/typescript-npm-cli-template · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._