# opt-cli > Execute CLI Statements based upon Opt-In / Opt-Out Rules. Latest version **1.6.0** (published 2017-10-20) · MIT license · 0 weekly downloads ## Install ```sh npm install opt-cli pnpm add opt-cli yarn add opt-cli bun add opt-cli ``` Provides the command `opt`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.6.0 | | Published | 2017-10-20 | | First published | 2016-03-21 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=4 | | Dependencies | 4 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 21 | | Author | Andreas Windt | | Maintainers | ta2edchimp | | Keywords | executer, cli, opt-in, opt-out | ## Links - npm: https://www.npmjs.com/package/opt-cli - Repository: https://github.com/ta2edchimp/opt-cli - Homepage: https://github.com/ta2edchimp/opt-cli#readme - Issues: https://github.com/ta2edchimp/opt-cli/issues - npm.io page: https://npm.io/package/opt-cli ## Dependencies (4) - [commander](https://npm.io/package/commander.md) 2.11.0 - [manage-path](https://npm.io/package/manage-path.md) 2.0.0 - [lodash.clone](https://npm.io/package/lodash.clone.md) 4.5.0 - [spawn-command](https://npm.io/package/spawn-command.md) 0.0.2-1 ## Alternatives - [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads - [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads - [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads - [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads - [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads ## Recent versions - 1.6.0 (latest) — 2017-10-20 - 1.5.2 — 2017-08-18 - 1.5.1 — 2016-06-26 - 1.5.0 — 2016-06-26 - 1.4.2 — 2016-04-20 - 1.4.1 — 2016-04-16 - 1.4.0 — 2016-03-29 - 1.3.0 — 2016-03-24 - 1.2.0 — 2016-03-23 - 1.1.1 — 2016-03-22 - 1.1.0 — 2016-03-22 - 1.0.0 — 2016-03-21 ## README # opt-cli Execute CLI Statements based upon opt-in / out-out Rules. [![version](https://img.shields.io/npm/v/opt-cli.svg?style=flat-square)](http://npm.im/opt-cli) [![Build Status](https://img.shields.io/travis/ta2edchimp/opt-cli/master.svg?style=flat-square)](https://travis-ci.org/ta2edchimp/opt-cli) [![Code Coverage](https://img.shields.io/codecov/c/github/ta2edchimp/opt-cli.svg?style=flat-square)](https://codecov.io/github/ta2edchimp/opt-cli) [![Dependencies status](https://img.shields.io/david/ta2edchimp/opt-cli.svg?style=flat-square)](https://david-dm.org/ta2edchimp/opt-cli#info=dependencies) [![MIT License](https://img.shields.io/npm/l/opt-cli.svg?style=flat-square)](http://opensource.org/licenses/MIT) [![downloads](https://img.shields.io/npm/dm/opt-cli.svg?style=flat-square)](http://npm-stat.com/charts.html?package=opt-cli&from=2016-03-20) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors) ## Installation Simply install locally as a development dependency to your project's package: ``` npm install --save-dev opt-cli ``` ## Intended usage Opting in/out of a configured tasks, **best use case is for ghooks**. [This discussion](https://github.com/gtramontina/ghooks/issues/48#issuecomment-194002689) is the main motivation behind this module. You can check out the [eslint-find-new-rules/package.json](https://github.com/kentcdodds/eslint-find-new-rules/blob/master/package.json#L67) for reference. ### `opt --in` ```JSON "config": { "ghooks": { "pre-commit": "opt --in pre-commit --exec 'npm run validate'" } }, ``` While `commit`ing, `npm run validate` **will not be executed** by default. However, one can **opt in by creating a `.opt-in` file in the root of the project, with the content `pre-commit`** #### `.opt-in` Each line in the `.opt-in` file, is the keyword used after the `opt --in` rule. So for the above example, it's `pre-commit` ``` cat .opt-in # "ghooks": { # "pre-commit": "opt --in pre-commit --exec 'npm run validate'" # } pre-commit # the keyword used after the opt --in command ``` ### `opt --out` `opt --out` works exactly, the opposite way of `opt --in`. ```JSON "config": { "ghooks": { "pre-commit": "opt --out pre-commit --exec 'npm run validate'" } }, ``` In this case, `npm run validate` **will be executed** before any changes can be `commit`ed. In order to **opt out, you have to create a `.opt-out` file in the root of the project, with the content `pre-commit`** #### `.opt-out` Similar to `.opt-in` file, each line in `.opt-out` file, is the keyword used after the `opt --out` rule. So for the above example, it's `pre-commit` ``` cat .opt-out # "ghooks": { # "pre-commit": "opt --out pre-commit --exec 'npm run validate'" # } pre-commit # the keyword used after the opt --out command ``` * **don't forget to update `.gitignore` to ignore this file.** * `opt-in`, `opt-out` files can contain multiple rules * every line must contain only a single rule. * `#` can be used to comment any rule. ## Use As Library You may also include opt-cli as a library: ```JavaScript var opt = require( 'opt-cli' ); ``` Given the example setup from above, usage would be as follows: ```JavaScript opt.testOptIn( 'pre-commit' ) === true opt.testOptOut( 'pre-push' ) === true ``` Using `opt.getExplicitOpts()` you would receive: ```JavaScript { 'pre-commit': true, 'pre-push': false } ``` ## Advanced Usage Rules to opt-into or opt-out of can also be specified using ... - ... an `in` or `out` array of a `package.json`'s `config.opt` field: ```JSON "config": { "opt": { "in": [ "pre-commit" ], "out": [ "pre-push" ] } }, ``` - ... the environment variables `OPT_IN` and `OPT_OUT`: ``` # Delimit multiple rules with ":" on *nix / ";" on Win export OPT_IN="pre-commit" export OPT_OUT="pre-push" ``` ## Contributors | [
Kent C. Dodds](https://twitter.com/kentcdodds)
[💻](https://github.com/ta2edchimp/opt-cli/commits?author=kentcdodds) 👀 | [
Guilherme J. Tramontina](https://github.com/gtramontina)
[💻](https://github.com/ta2edchimp/opt-cli/commits?author=gtramontina) | [
Andreas Windt](https://twitter.com/ta2edchimp)
[💻](https://github.com/ta2edchimp/opt-cli/commits?author=ta2edchimp) [📖](https://github.com/ta2edchimp/opt-cli/commits?author=ta2edchimp) [⚠️](https://github.com/ta2edchimp/opt-cli/commits?author=ta2edchimp) | [
Sarbbottam Bandyopadhyay](https://twitter.com/sarbbottam)
[📖](https://github.com/ta2edchimp/opt-cli/commits?author=sarbbottam) | [
Suhas Karanth](https://github.com/sudo-suhas)
[🐛](https://github.com/ta2edchimp/opt-cli/issues?q=author%3Asudo-suhas) [💻](https://github.com/ta2edchimp/opt-cli/commits?author=sudo-suhas) | | :---: | :---: | :---: | :---: | :---: | This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)). [Contributions of any kind welcome](CONTRIBUTING.md)! Special thanks to [@kentcdodds](https://github.com/kentcdodds) for encouraging to engage in oss, for the wonderful resources (check out the [Egghead videos!](https://egghead.io/series/how-to-write-an-open-source-javascript-library)) and — together with [gtramontina](https://github.com/gtramontina) — for coming up with [the original idea to this module](https://github.com/gtramontina/ghooks/issues/48#issuecomment-194002689)! --- _Source: https://npm.io/package/opt-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._