| <!doctype html> |
| <html> |
| <title>npm-dist-tag</title> |
| <meta http-equiv="content-type" value="text/html;utf-8"> |
| <link rel="stylesheet" type="text/css" href="../../static/style.css"> |
| <link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-dist-tag.html"> |
| <script async=true src="../../static/toc.js"></script> |
| |
| <body> |
| <div id="wrapper"> |
| |
| <h1><a href="../cli/npm-dist-tag.html">npm-dist-tag</a></h1> <p>Modify package distribution tags</p> |
| <h2 id="synopsis">SYNOPSIS</h2> |
| <pre><code>npm dist-tag add <pkg>@<version> [<tag>] |
| npm dist-tag rm <pkg> <tag> |
| npm dist-tag ls [<pkg>] |
| |
| aliases: dist-tags |
| </code></pre><h2 id="description">DESCRIPTION</h2> |
| <p>Add, remove, and enumerate distribution tags on a package:</p> |
| <ul> |
| <li><p>add: |
| Tags the specified version of the package with the specified tag, or the |
| <code>--tag</code> config if not specified.</p> |
| </li> |
| <li><p>rm: |
| Clear a tag that is no longer in use from the package.</p> |
| </li> |
| <li><p>ls: |
| Show all of the dist-tags for a package, defaulting to the package in |
| the current prefix.</p> |
| </li> |
| </ul> |
| <p>A tag can be used when installing packages as a reference to a version instead |
| of using a specific version number:</p> |
| <pre><code>npm install <name>@<tag> |
| </code></pre><p>When installing dependencies, a preferred tagged version may be specified:</p> |
| <pre><code>npm install --tag <tag> |
| </code></pre><p>This also applies to <code>npm dedupe</code>.</p> |
| <p>Publishing a package sets the <code>latest</code> tag to the published version unless the |
| <code>--tag</code> option is used. For example, <code>npm publish --tag=beta</code>.</p> |
| <p>By default, <code>npm install <pkg></code> (without any <code>@<version></code> or <code>@<tag></code> |
| specifier) installs the <code>latest</code> tag.</p> |
| <h2 id="purpose">PURPOSE</h2> |
| <p>Tags can be used to provide an alias instead of version numbers.</p> |
| <p>For example, a project might choose to have multiple streams of development |
| and use a different tag for each stream, |
| e.g., <code>stable</code>, <code>beta</code>, <code>dev</code>, <code>canary</code>.</p> |
| <p>By default, the <code>latest</code> tag is used by npm to identify the current version of |
| a package, and <code>npm install <pkg></code> (without any <code>@<version></code> or <code>@<tag></code> |
| specifier) installs the <code>latest</code> tag. Typically, projects only use the <code>latest</code> |
| tag for stable release versions, and use other tags for unstable versions such |
| as prereleases.</p> |
| <p>The <code>next</code> tag is used by some projects to identify the upcoming version.</p> |
| <p>By default, other than <code>latest</code>, no tag has any special significance to npm |
| itself.</p> |
| <h2 id="caveats">CAVEATS</h2> |
| <p>This command used to be known as <code>npm tag</code>, which only created new tags, and so |
| had a different syntax.</p> |
| <p>Tags must share a namespace with version numbers, because they are specified in |
| the same slot: <code>npm install <pkg>@<version></code> vs <code>npm install <pkg>@<tag></code>.</p> |
| <p>Tags that can be interpreted as valid semver ranges will be rejected. For |
| example, <code>v1.4</code> cannot be used as a tag, because it is interpreted by semver as |
| <code>>=1.4.0 <1.5.0</code>. See <a href="https://github.com/npm/npm/issues/6082">https://github.com/npm/npm/issues/6082</a>.</p> |
| <p>The simplest way to avoid semver problems with tags is to use tags that do not |
| begin with a number or the letter <code>v</code>.</p> |
| <h2 id="see-also">SEE ALSO</h2> |
| <ul> |
| <li><a href="../cli/npm-tag.html">npm-tag(1)</a></li> |
| <li><a href="../cli/npm-publish.html">npm-publish(1)</a></li> |
| <li><a href="../cli/npm-install.html">npm-install(1)</a></li> |
| <li><a href="../cli/npm-dedupe.html">npm-dedupe(1)</a></li> |
| <li><a href="../misc/npm-registry.html">npm-registry(7)</a></li> |
| <li><a href="../cli/npm-config.html">npm-config(1)</a></li> |
| <li><a href="../misc/npm-config.html">npm-config(7)</a></li> |
| <li><a href="../files/npmrc.html">npmrc(5)</a></li> |
| </ul> |
| |
| </div> |
| |
| <table border=0 cellspacing=0 cellpadding=0 id=npmlogo> |
| <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr> |
| <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr> |
| <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr> |
| <tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr> |
| <tr><td style="width:10px;height:10px;background:#fff"> </td></tr> |
| <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr> |
| <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr> |
| </table> |
| <p id="footer">npm-dist-tag — npm@2.15.8</p> |
| |
