cli-examples

An example project that shows how to use @carnesen/cli

Usage

This project is crafted as a Node.js CLI, but most of the commands are universal JavaScript.

Inspect the code:

• On the web: GitHub
• Locally: git clone the carnesen/cli monorepo and cd cli/examples

Run the examples:

• On the web: cli.carnesen.com
• Locally with Node.js: npx -q @carnesen/cli-examples

Content

• package.json: Defines package configuration, dependencies, development and build scripts. Feel free to use any of the @carnesen/* packages for your own projects. They're all actively maintained.

• src: .ts TypeScript source code

• lib: Runtime .js JavaScript and .d.ts type declarations generated by the TypeScript compiler in npm run build

• src/index.ts: Source code for this package's "main" export. Usually a CLI package doesn't have any exports, but in this case we use some of the example commands for the @carnesen/cli website too.

• src/cli.ts: Source code for this package's "bin" executable

• jest.config.js: Jest configuration file for npm run unit-test.

• tsconfig.json: TypeScript configuration file

• .eslintrc.json: ESLint configuration file for npm run lint and npm run fix

License

MIT © Chris Arnesen