https://github.com/devcrossnet/cross-platform-cli-template

A template for building cross platform CLIs with node.js and Typescript
https://github.com/devcrossnet/cross-platform-cli-template

Last synced: 28 days ago
JSON representation

A template for building cross platform CLIs with node.js and Typescript

• Host: GitHub
• URL: https://github.com/devcrossnet/cross-platform-cli-template
• Owner: devCrossNet
• License: mit
• Created: 2018-08-12T16:54:06.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T22:45:11.000Z (almost 2 years ago)
• Last Synced: 2024-10-05T21:01:52.179Z (about 1 month ago)
• Language: TypeScript
• Size: 111 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# cross-platform-cli-template

> A template for building cross platform CLIs with node.js and Typescript

# Development

1. Install Node.js 8.x or higher.

2. Install npm version 5.x or higher

3. Clone the repository `git clone https://github.com/devCrossNet/cross-platform-cli-template.git`

4. Change directory `cd cross-platform-cli-template`

5. Install dependencies: `npm link`

6. Run `npm run watch`

Now the binary is available to test with `myCLI -h`

## Build

run `npm run build` to create binaries for all platforms.

# Reference resources

- [chalk](https://github.com/chalk/chalk)

- [commander](https://github.com/tj/commander.js/)

- [inquirer](https://github.com/SBoudrias/Inquirer.js)

- [pkg](https://github.com/zeit/pkg)