https://github.com/mirkoschubert/mgen-ts

https://github.com/mirkoschubert/mgen-ts

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/mirkoschubert/mgen-ts
• Owner: mirkoschubert
• License: mit
• Archived: true
• Created: 2021-08-05T08:22:28.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-08-05T08:22:29.000Z (almost 5 years ago)
• Last Synced: 2025-03-02T00:16:34.258Z (over 1 year ago)
• Language: TypeScript
• Size: 50.8 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# typescript-cli-starter

A simple and zero-opinion typescript starter template for building cross-platform command line applications.

![GitHub package.json dynamic](https://img.shields.io/github/package-json/keywords/khalidx/typescript-cli-starter.svg?style=flat-square)

![GitHub](https://img.shields.io/github/license/khalidx/typescript-cli-starter.svg?style=flat-square)

![GitHub package.json version](https://img.shields.io/github/package-json/v/khalidx/typescript-cli-starter.svg?style=flat-square)

![GitHub top language](https://img.shields.io/github/languages/top/khalidx/typescript-cli-starter.svg?style=flat-square)

![GitHub last commit](https://img.shields.io/github/last-commit/khalidx/typescript-cli-starter.svg?style=flat-square)

Includes:

- [TypeScript](https://www.typescriptlang.org/), for writing good code

- [Ava](https://www.npmjs.com/package/ava), for writing good tests

- [Commander](https://www.npmjs.com/package/commander), for building CLI applications

- [Pkg](https://www.npmjs.com/package/pkg), for building cross-platform native executables

Your application will be installable from `npm` or by sharing your native executables.

## Usage

### **dev**

`npm run dev`

Runs the CLI application.

You can pass arguments to your application by running `npm run dev -- --your-argument`. The extra `--` is so that your arguments are passed to your CLI application, and not `npm`.

### **clean**

`npm run clean`

Removes any built code and any built executables.

### **build**

`npm run build`

Cleans, then builds the TypeScript code.

Your built code will be in the `./dist/` directory.

### **test**

`npm run test`

Cleans, then builds, and tests the built code.

### **bundle**

`npm run bundle`

Cleans, then builds, then bundles into native executables for Windows, Mac, and Linux.

Your shareable executables will be in the `./exec/` directory.