Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brynbellomy/nappy
View formatted node.js api documentation in the cli / terminal
https://github.com/brynbellomy/nappy
Last synced: about 1 month ago
JSON representation
View formatted node.js api documentation in the cli / terminal
- Host: GitHub
- URL: https://github.com/brynbellomy/nappy
- Owner: brynbellomy
- Created: 2012-10-17T04:09:19.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2012-11-07T17:53:08.000Z (about 12 years ago)
- Last Synced: 2024-08-09T21:08:58.597Z (3 months ago)
- Language: JavaScript
- Homepage: http://brynbellomy.github.com/nappy
- Size: 391 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# // nappy
`nappy` queries the latest **node.js api** docs from the **command line**.
# installing
```sh
$ npm install -g nappy
```
# basic usage
```sh
$ nappy fs.readFile
```
# command-line options
```
Usage:
$ nappy [options]
Options:
-c, --coffee Output code blocks as coffeescript. [boolean] [default: false]
-w, --wipe-cache Wipe the locally-cached version of the API docs and re-download. [boolean] [default: false]
-d, --debug Display debug output. [boolean] [default: false]
```
# commands
### function (aliases: `f`, `func`, `m`, `method`)
displays documentation for a single function.
ex: `$ nappy f fs.readFile`
### class (aliases: `c`)
displays documentation for a class.
ex: `$ nappy c child_process.ChildProcess`
### ls (aliases: `l`, `list`)
lists the functions and classes exported by a module.
ex: `$ nappy ls util`
# how to specify the 'thing to lookup'
for the `ls` command, simply specify the module name you'd like to see the contents of.
for `function` and `class`, you must specify `.` (i.e. `fs.readFile`, etc.)
# nappy caches the api docs for offline viewing
good for coding on airplanes if you don't have $5 to blow on airtran wi-fi. if you need to clear the cache, just pass the `-w` flag. but don't do it while you're offline or you'll bust the cache and refill it with _**a vast nothingness**_.
```sh
nappy -w util.inspect
```
# @todo
- customizable color schemes
# authors / contributors
bryn austin bellomy < >
# license (wtfpl v2)
```
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004
Copyright (C) 2004 Sam Hocevar
Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. You just DO WHAT THE FUCK YOU WANT TO.
```