[project] Nodeman, 알짜배기 Node.js Cli Manual

nodeman 소개

node.js 문서를 command line에서 제공하고, Node.js Black Edition의 Helper로서 동작하는데 부가적인 목적이 있습니다. github의 readme를 긁어와서 바로 보여줄 수 있지만, 사용해보고 중요한 부분을 color module을 사용하여 이쁘게 제공합니다. 문서의 업데이트는 module 중요도에 따라 계속 쭈~욱 된다는것을 약속드립니다.

동기

리눅스에는 man 명령어가 있습니다. Node.js 에도 필요하지 않을까? github 찾아가서 readme 보는것도 귀찮아서, 생각을 하자마자 프로젝트를 진행하기 시작했습니다. 하루에 2개씩만 만들어도 1년이면 700 여개입니다. :)

DEMO

nodeman 을 사용하여 scrap 빨리 하기 restler 라는 모듈을 어디서 듣긴 했는데, 메뉴얼을 찾을려니 귀찮아지면 nodeman restler 를 실행하여 터미널에서 바로 코드조각을 얻어낼 수 있다.

npm install nodeman -g
npm update nodeman -g

URL

• github repo
• startic

설치

npm install nodeman -g

업데이트

수시로 업데이트 됩니다. 현재 40여개의 자주사용하는 모듈의 도움말이 포함되어 있습니다.

npm update nodeman -g

문서추가 방법

• 누구나 github repo를 clone하여 pull request 하실 수 있습니다.
• github에 README에 기재된 모든 내용보다는 필수적인 요소만 추출하고, 중요한 부분은 색상을 입혀서 작업시에 유용하게 참고할 수 있도록 작성해야 합니다.
• docs 디렉토리안에 moduleName.js 규칙으로 생성되어야 합니다.
• 파일의 형식은 아래와 같습니다.

exports.name = 'moduleName';
exports.category = 'category name';
exports.context = 'use require';
exports.homepage = 'http://homepage';
exports.description = [
   "\\t blah blah"
   , "\\t blah blah"
].join('\\n');

사용방법

cli

$ nodeman or nodeman -h

$ nodeman -b

$ nodeman optimist | more

bsd 에서는 ansi-color code를 raw 그대로 표현하기 때문에 more -R 옵션을 사용하세요.

$ nodeman -m

repl

$ node
> var man = require('nodeman');
> man.help('optimist')

KIN 플~