Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

npm-publish (1)

Name

npm-publish - Publish a package

Synopsis

npm publish [<tarball>|<folder>] [--tag <tag>] [--access <public|restricted>] [--otp otpcode] [--dry-run]

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

Description

NPM-PUBLISH(1)                                                  NPM-PUBLISH(1)



NAME
       npm-publish - Publish a package

SYNOPSIS
         npm publish [<tarball>|<folder>] [--tag <tag>] [--access <public|restricted>] [--otp otpcode] [--dry-run]

         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 .git-
       ignore  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  over-
       ridden by specifying a different default registry or using a npm help 7
       npm-scope in the name (see npm help 5 package.json).

       o <folder>: A folder containing a package.json file

       o <tarball>: A url or file path to a gzipped tar archive  containing  a
         single folder with a package.json file inside.

       o [--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.

       o [--access <public|restricted>] Tells the registry whether this  pack-
         age  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.

       o [--otp <otpcode>] If you have two-factor  authentication  enabled  in
         auth-and-writes  mode then you can provide a code from your authenti-
         cator with this. If you don't include this and you're running from  a
         TTY then you'll be prompted.

       o [--dry-run] Does everything publish would do except actually publish-
         ing to the registry.  Reports the details of  what  would  have  been
         published.


       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  spe-
       cific  name and version combination can never be used again, even if it
       is removed with npm help unpublish.

       As of npm@5, both a sha1sum and an integrity field with a sha512sum  of
       the  tarball will be submitted to the registry during publication. Sub-
       sequent installs will use the strongest supported algorithm  to  verify
       downloads.

       Similar to --dry-run see npm help npm-pack, which figures out the files
       to be included and packs them into a tarball to be uploaded to the reg-
       istry.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-------------------------+
       |ATTRIBUTE TYPE |    ATTRIBUTE VALUE      |
       +---------------+-------------------------+
       |Availability   | runtime/nodejs/nodejs-8 |
       +---------------+-------------------------+
       |Stability      | Pass-thru volatile      |
       +---------------+-------------------------+
SEE ALSO
       o npm help 7 registry

       o npm help 7 scope

       o npm help adduser

       o npm help owner

       o npm help deprecate

       o npm help dist-tag

       o npm help pack

       o npm help profile





NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source    was   downloaded   from    https://github.com/nodejs/node/ar-
       chive/v8.15.1.zip

       Further information about this software can be found on the open source
       community website at https://github.com/nodejs/node.



                                  August 2018                   NPM-PUBLISH(1)