UNPKG

@anycli/cli/README.md

Version:

1.85 kBMarkdownView Raw

1anycli
2======
3
4anycli: create your own CLI
5
6[![Version](https://img.shields.io/npm/v/anycli.svg)](https://npmjs.org/package/anycli)
7[![CircleCI](https://circleci.com/gh/anycli/anycli/tree/master.svg?style=svg)](https://circleci.com/gh/anycli/anycli/tree/master)
8[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/anycli/anycli?branch=master&svg=true)](https://ci.appveyor.com/project/heroku/anycli/branch/master)
9[![Codecov](https://codecov.io/gh/anycli/anycli/branch/master/graph/badge.svg)](https://codecov.io/gh/anycli/anycli)
10[![Greenkeeper](https://badges.greenkeeper.io/anycli/anycli.svg)](https://greenkeeper.io/)
11[![Known Vulnerabilities](https://snyk.io/test/npm/anycli/badge.svg)](https://snyk.io/test/npm/anycli)
12[![Downloads/week](https://img.shields.io/npm/dw/anycli.svg)](https://npmjs.org/package/anycli)
13[![License](https://img.shields.io/npm/l/anycli.svg)](https://github.com/anycli/anycli/blob/master/package.json)
14
15Useful Repos
16------------
17
18**Plugins**
19
20* [@anycli/version](https://github.com/anycli/version) - `mycli -v|--version|version`. Show the current version.
21* [@anycli/not-found](https://github.com/anycli/not-found) - Display a friendly "did you mean" message if a command is not found.
22* [@anycli/plugins](https://github.com/anycli/plugins) - Allow users to add plugins to extend your CLI.
23* [@anycli/autoupdate](https://github.com/anycli/autoupdate) - Add autoupdate support to the CLI.
24* [@anycli/autocomplete](https://github.com/anycli/autocomplete) - Add bash/zsh autocomplete.
25
26Building your own plugin
27------------------------
28
29Writing code for plugins is essentially the same as writing within a CLI. They can export 3 different types: commands, hooks, and other plugins.
30
31Run `yarn create anycli plugin mynewplugin` to create a plugin a new directory. This will come with a sample command and hook

1	`anycli`
2	`======`
3
4	`anycli: create your own CLI`
5
6	`[![Version](https://img.shields.io/npm/v/anycli.svg)](https://npmjs.org/package/anycli)`
7	`[![CircleCI](https://circleci.com/gh/anycli/anycli/tree/master.svg?style=svg)](https://circleci.com/gh/anycli/anycli/tree/master)`
8	`[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/anycli/anycli?branch=master&svg=true)](https://ci.appveyor.com/project/heroku/anycli/branch/master)`
9	`[![Codecov](https://codecov.io/gh/anycli/anycli/branch/master/graph/badge.svg)](https://codecov.io/gh/anycli/anycli)`
10	`[![Greenkeeper](https://badges.greenkeeper.io/anycli/anycli.svg)](https://greenkeeper.io/)`
11	`[![Known Vulnerabilities](https://snyk.io/test/npm/anycli/badge.svg)](https://snyk.io/test/npm/anycli)`
12	`[![Downloads/week](https://img.shields.io/npm/dw/anycli.svg)](https://npmjs.org/package/anycli)`
13	`[![License](https://img.shields.io/npm/l/anycli.svg)](https://github.com/anycli/anycli/blob/master/package.json)`
14
15	`Useful Repos`
16	`------------`
17
18	`Plugins`
19
20	* [@anycli/version](https://github.com/anycli/version) - `mycli -v\|--version\|version`. Show the current version.
21	`* [@anycli/not-found](https://github.com/anycli/not-found) - Display a friendly "did you mean" message if a command is not found.`
22	`* [@anycli/plugins](https://github.com/anycli/plugins) - Allow users to add plugins to extend your CLI.`
23	`* [@anycli/autoupdate](https://github.com/anycli/autoupdate) - Add autoupdate support to the CLI.`
24	`* [@anycli/autocomplete](https://github.com/anycli/autocomplete) - Add bash/zsh autocomplete.`
25
26	`Building your own plugin`
27	`------------------------`
28
29	`Writing code for plugins is essentially the same as writing within a CLI. They can export 3 different types: commands, hooks, and other plugins.`
30
31	Run `yarn create anycli plugin mynewplugin` to create a plugin a new directory. This will come with a sample command and hook