A simple and zero-opinion typescript starter template for building cross-platform command line applications.
Includes:
- TypeScript, for writing good code
- Ava, for writing good tests
- Commander, for building CLI applications
- Pkg, for building cross-platform native executables
Your application will be installable from npm or by sharing your native executables.
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.
npm run clean
Removes any built code and any built executables.
npm run build
Cleans, then builds the TypeScript code.
Your built code will be in the ./dist/ directory.
npm run test
Cleans, then builds, and tests the built code.
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.