cli-starter

A command line tool template.

Try it now!

Create repo from this template on Github

Or:

1$ npx degit peterroe/cli-starter my-cli
2$ cd my-cli
3$ git init
4$ pnpm i    # npm install -g pnpm

Development

Modify package.json

1{
2- "name": "cli-starter",
3+ "name": "my-cli",
4  "bin": {
5-    "cli-starter": "./bin/index.mjs"
6+    "my-cli": "./bin/index.mjs"
7  },

Then you can link your cli tool to global

1$ pnpm stub
2$ pnpm link --global

Example

This command will help you understand how cli tool works:

1$ my-cli -h # show help
2$ my-cli -v # show version
3$ my-cli lint one two --name peterroe # demo usage

And then you can rewrite src/index.ts to what you want

Here are some projects that use cli-starter: renames、tind

More usage about cac please see cac

Build && Publish

Build it:

1$ pnpm build

Publish to npm:

1$ git remote add origin xxx # make sure you have bound a repo
2$ git push origin main 
3$ pnpm release # or npm publish directly

Try yourself!

Install your own command line tool:

$ npm install -g xxx
$ xxx -h
$ xxx -v

Then use it...