https://github.com/p-adams/vue-help

Vue.js API in the Terminal
https://github.com/p-adams/vue-help

chalk vorpal vuejs

Last synced: 7 days ago
JSON representation

Vue.js API in the Terminal

• Host: GitHub
• URL: https://github.com/p-adams/vue-help
• Owner: p-adams
• Created: 2017-07-14T15:52:25.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-08-08T23:03:24.000Z (over 4 years ago)
• Last Synced: 2024-09-18T11:58:02.376Z (about 2 months ago)
• Topics: chalk, vorpal, vuejs
• Language: JavaScript
• Homepage:
• Size: 2.18 MB
• Stars: 45
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# vue-help

Vue.js API in the Terminal

##### up-to-date with Vue 2.4.0

###### screenshot



#### Motivation

vue-help was created to facilitate access to all of Vue's APIs without the need for a browser or internet connection.

#### Usage

##### Install

`npm install -g vue-help`

##### Start CLI

`vue-help`

##### Enter API name at the prompt

For example:

```

    vue-help$ devtools

                    Category: Global Config

                    Name: devtools

                    * Type: boolean

                    * Default: true ( false in production builds)

                    * Usage: // make sure to set this synchronously immediately after loading Vue

                            Vue.config.devtools = true

                    * Details: Check whether to allow vue-devtools inspection.

                            This option's default value is true in development builds and false in production builds.

                            You can set it to true to enable inspection for production builds

```

##### or enter help to list all commands

`vue-help? help`

#### Inspiration

Clojure's `(doc name)` function

https://clojuredocs.org/clojure.repl/doc

Elixir's `h/1` function

https://hexdocs.pm/iex/IEx.Helpers.html