https://github.com/flex-development/nest-commander

A NestJS module for building CLI applications
https://github.com/flex-development/nest-commander

cli cli-program command-line commander nest nestjs nestjs-module typescript

Last synced: 8 months ago
JSON representation

A NestJS module for building CLI applications

• Host: GitHub
• URL: https://github.com/flex-development/nest-commander
• Owner: flex-development
• License: bsd-3-clause
• Created: 2023-08-10T22:15:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-14T22:05:22.000Z (over 1 year ago)
• Last Synced: 2025-03-12T09:47:39.796Z (9 months ago)
• Topics: cli, cli-program, command-line, commander, nest, nestjs, nestjs-module, typescript
• Language: TypeScript
• Homepage: https://github.com/flex-development/nest-commander
• Size: 3.8 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/funding.yml
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# nest-commander

[![github release](https://img.shields.io/github/v/release/flex-development/nest-commander.svg?include_prereleases&sort=semver)](https://github.com/flex-development/nest-commander/releases/latest)

[![npm](https://img.shields.io/npm/v/@flex-development/nest-commander.svg)](https://npmjs.com/package/@flex-development/nest-commander)

[![codecov](https://codecov.io/gh/flex-development/nest-commander/branch/main/graph/badge.svg?token=GcyvLXLmzn)](https://codecov.io/gh/flex-development/nest-commander)

[![module type: esm](https://img.shields.io/badge/module%20type-esm-brightgreen)](https://github.com/voxpelli/badges-cjs-esm)

[![license](https://img.shields.io/github/license/flex-development/nest-commander.svg)](LICENSE.md)

[![conventional commits](https://img.shields.io/badge/-conventional%20commits-fe5196?logo=conventional-commits&logoColor=ffffff)](https://conventionalcommits.org/)

[![typescript](https://img.shields.io/badge/-typescript-3178c6?logo=typescript&logoColor=ffffff)](https://typescriptlang.org/)

[![vitest](https://img.shields.io/badge/-vitest-6e9f18?style=flat&logo=vitest&logoColor=ffffff)](https://vitest.dev/)

[![yarn](https://img.shields.io/badge/-yarn-2c8ebb?style=flat&logo=yarn&logoColor=ffffff)](https://yarnpkg.com/)

A NestJS module for building CLI applications

## Contents

- [What is this?](#what-is-this)

- [Install](#install)

- [Use](#use)

- [Types](#types)

- [Contribute](#contribute)

## What is this?

[NestJS][1] is a framework for building [Node.js][2] server-side applications. It can also be used, however, to build

[standalone applications][3], thus allowing developers to implement the same architectural patterns across applications.

Built on top of [Commander.js][4], `nest-commander` brings the NestJS developer experience to CLI applications.

## Install

This package is [ESM only][5].

```sh

yarn add -D @flex-development/nest-commander @nestjs/common @nestjs/core @nestjs/testing

```

From Git:

```sh

yarn add -D @flex-development/nest-commander@flex-development/nest-commander @nestjs/common @nestjs/core @nestjs/testing

```



  

    See Git Protocol | Yarn

     for details on requesting a specific branch, commit, or tag.

  



## Use

**TODO**: usage docs

## Types

This package is fully typed with [TypeScript][6].

## Contribute

See [`CONTRIBUTING.md`](CONTRIBUTING.md).

[1]: https://docs.nestjs.com/

[2]: https://nodejs.org/

[3]: https://docs.nestjs.com/standalone-applications

[4]: https://github.com/tj/commander.js

[5]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[6]: https://www.typescriptlang.org