NPM-PUBLISH

Section: (1)
Updated: November 2016
Index Return to Main Contents
 

NAME

npm-publish - Publish a package  

SYNOPSIS

npm publish [<tarball>|<folder>] [--tag <tag>] [--access <public|restricted>]

Publishes '.' if no argument supplied
Sets tag 'latest' if no --tag specified
 

DESCRIPTION

Publishes a package to the registry so that it can be installed by name. All files in the package directory are included if no local .gitignore or .npmignore file exists. If both files exist and a file is ignored by .gitignore but not by .npmignore then it will be included. See npm help 7 npm-developers for full details on what's included in the published package, as well as details on how the package is built.

By default npm will publish to the public registry. This can be overridden by specifying a different default registry or using a npm help 7 npm-scope in the name (see npm help 5 package.json).

•
<folder>: A folder containing a package.json file
•
<tarball>: A url or file path to a gzipped tar archive containing a single folder with a package.json file inside.
•
[--tag <tag>] Registers the published package with the given tag, such that npm install <name>@<tag> will install this version. By default, npm publish updates and npm install installs the latest tag. See npm help npm-dist-tag for details about tags.
•
[--access <public|restricted>] Tells the registry whether this package should be published as public or restricted. Only applies to scoped packages, which default to restricted. If you don't have a paid account, you must publish with --access public to publish scoped packages.

Fails if the package name and version combination already exists in the specified registry.

Once a package is published with a given name and version, that specific name and version combination can never be used again, even if it is removed with npm help unpublish.

For a "dry run" that does everything except actually publishing to the registry, see npm help npm-pack, which figures out the files to be included and packs them into a tarball to be uploaded to the registry.  

SEE ALSO

•
npm help 7 registry
•
npm help 7 scope
•
npm help adduser
•
npm help owner
•
npm help deprecate
•
npm help tag
•
npm help pack

 

Index

NAME
SYNOPSIS
DESCRIPTION
SEE ALSO
This document was created by