README.md

@messageflow/clean-cli

CLI for @messageflow/clean

---

Yet another opinionated CLI to reset your working directory with @messageflow/clean.

Table of contents

• Pre-requisites
• Setup
  • Install
  • Run with npx (recommended)
  • Or, install globally
  • Usage
    • With npx (recommended)
• License

Pre-requisites

• Node.js >= 8.9.0
• NPM >= 5.5.1 (NPM comes with Node.js so there is no need to install separately.)

Setup

Install

Run with npx (recommended)

# Run CLi with npx
$ npx -p @messageflow/clean-cli -- clean

Or, install globally

# Install via NPM globally
$ npm install --global @messageflow/clean-cli

Usage

With npx (recommended)

$ npx -p @messageflow/clean-cli -- clean --help

Usage
$ clean <path|glob> ...

Options
  -i, --file    Specify the path to read \`.gitignore\`
  -p, --path    Specify the glob patterns to delete files/ folders.
  -f, --force   Allow deleting the current working directory and outside
  -d, --dry-run List what would be deleted instead of deleting

Examples
  $ clean .
  $ clean -i ./.gitignore
  $ clean -i ./.gitignore -d
  $ clean -p "**/src/**/*.js,**/src/**/*.d.ts,!gulpfile.js"

License

MIT License © Rong Sen Ng