deps/npm/man/man3/npm-edit.3

   1 .\" Generated with Ronnjs 0.3.8
   2 .\" http://github.com/kapouer/ronnjs/
   3 .
   4 .TH "NPM\-EDIT" "3" "November 2013" "" ""
   5 .
   6 .SH "NAME"
   7 \fBnpm-edit\fR \-\- Edit an installed package
   8 .
   9 .SH "SYNOPSIS"
  10 .
  11 .nf
  12 npm\.commands\.edit(package, callback)
  13 .
  14 .fi
  15 .
  16 .SH "DESCRIPTION"
  17 Opens the package folder in the default editor (or whatever you\'ve
  18 configured as the npm \fBeditor\fR config \-\- see \fBnpm help config\fR\|\.)
  19 .
  20 .P
  21 After it has been edited, the package is rebuilt so as to pick up any
  22 changes in compiled packages\.
  23 .
  24 .P
  25 For instance, you can do \fBnpm install connect\fR to install connect
  26 into your package, and then \fBnpm\.commands\.edit(["connect"], callback)\fR
  27 to make a few changes to your locally installed copy\.
  28 .
  29 .P
  30 The first parameter is a string array with a single element, the package
  31 to open\. The package can optionally have a version number attached\.
  32 .
  33 .P
  34 Since this command opens an editor in a new process, be careful about where
  35 and how this is used\.