UNPKG

npm

Version:

A package manager for node

38 lines (36 loc) 1.56 kB
<h1><a href="../api/npm-config.html">npm-config</a></h1> <p>Manage the npm configuration files</p> <h2 id="synopsis">SYNOPSIS</h2> <pre><code>npm.commands.config(args, callback) var val = npm.config.get(key) npm.config.set(key, val) </code></pre><h2 id="description">DESCRIPTION</h2> <p>This function acts much the same way as the command-line version. The first element in the array tells config what to do. Possible values are:</p> <ul> <li><p><code>set</code></p> <p> Sets a config parameter. The second element in <code>args</code> is interpreted as the key, and the third element is interpreted as the value.</p> </li> <li><p><code>get</code></p> <p> Gets the value of a config parameter. The second element in <code>args</code> is the key to get the value of.</p> </li> <li><p><code>delete</code> (<code>rm</code> or <code>del</code>)</p> <p> Deletes a parameter from the config. The second element in <code>args</code> is the key to delete.</p> </li> <li><p><code>list</code> (<code>ls</code>)</p> <p> Show all configs that aren&#39;t secret. No parameters necessary.</p> </li> <li><p><code>edit</code>:</p> <p> Opens the config file in the default editor. This command isn&#39;t very useful programmatically, but it is made available.</p> </li> </ul> <p>To programmatically access npm configuration settings, or set them for the duration of a program, use the <code>npm.config.set</code> and <code>npm.config.get</code> functions instead.</p> <h2 id="see-also">SEE ALSO</h2> <ul> <li><a href="../api/npm.html">npm(3)</a></li> </ul>