CLI Starter Kit

How to get started with cli-starter-kit

# in your project root, initialize an empty git repo
git init

# pull next-starter-kit
git pull [e-mail]:thesunny/cli-starter-kit.git

# Open the directory and `package.json`
code . package.json

IMPORTANT! Modify "package.json"

Edit these lines in package.json to fit your needs

{
  "name": "name-of-your-package",
  "version": "0.1.0",
  "description": "Description of your package",
  "bin": {
    "name-of-command": "./.dist/index.js"
  },
  "dependencies": {
    // when you `yarn build` make sure all `(!) Unresolved dependencies` are
    // in here and not in `devDependencies`
  }
}

How to update

# use the built in script
yarn update:kit

# or manually re-pull cli-starter-kit
git pull [e-mail]:thesunny/cli-starter-kit.git

How to publish

This will bump the version.

yarn prepublish

Resources

Starter kit for creating NPM packages with executable scripts.

A guide to creating a NodeJS command-line package

Write a simple node executable with typescript and vscode