Gecko [ c.stage.kornherr.net ]

Name	Size	Permission	Date
npm-access.md	2.56 KB	-rw-r--r--	2022-12-07 23:13
npm-adduser.md	832 B	-rw-r--r--	2022-12-07 23:13
npm-audit.md.gz	3.33 KB	-rw-r--r--	2022-12-07 23:13
npm-bugs.md	840 B	-rw-r--r--	2022-12-07 23:13
npm-cache.md	2.73 KB	-rw-r--r--	2022-12-07 23:13
npm-ci.md	2.07 KB	-rw-r--r--	2022-12-07 23:13
npm-completion.md	924 B	-rw-r--r--	2022-12-07 23:13
npm-config.md	2.13 KB	-rw-r--r--	2022-12-07 23:13
npm-dedupe.md	2.13 KB	-rw-r--r--	2022-12-07 23:13
npm-deprecate.md	1.31 KB	-rw-r--r--	2022-12-07 23:13
npm-diff.md.gz	1.98 KB	-rw-r--r--	2022-12-07 23:13
npm-dist-tag.md	3.2 KB	-rw-r--r--	2022-12-07 23:13
npm-docs.md	820 B	-rw-r--r--	2022-12-07 23:13
npm-doctor.md.gz	2.16 KB	-rw-r--r--	2022-12-07 23:13
npm-edit.md	922 B	-rw-r--r--	2022-12-07 23:13
npm-exec.md.gz	3.3 KB	-rw-r--r--	2022-12-07 23:13
npm-explain.md	1.81 KB	-rw-r--r--	2022-12-07 23:13
npm-explore.md	880 B	-rw-r--r--	2022-12-07 23:13
npm-find-dupes.md	511 B	-rw-r--r--	2022-12-07 23:13
npm-fund.md	1.93 KB	-rw-r--r--	2022-12-07 23:13
npm-help-search.md	693 B	-rw-r--r--	2022-12-07 23:13
npm-help.md	840 B	-rw-r--r--	2022-12-07 23:13
npm-hook.md	1.87 KB	-rw-r--r--	2022-12-07 23:13
npm-init.md.gz	1.92 KB	-rw-r--r--	2022-12-07 23:13
npm-install-ci-test.md	437 B	-rw-r--r--	2022-12-07 23:13
npm-install-test.md	497 B	-rw-r--r--	2022-12-07 23:13
npm-install.md.gz	4.73 KB	-rw-r--r--	2022-12-07 23:13
npm-link.md	3.95 KB	-rw-r--r--	2022-12-07 23:13
npm-login.md	1.15 KB	-rw-r--r--	2022-12-07 23:13
npm-logout.md	949 B	-rw-r--r--	2022-12-07 23:13
npm-ls.md	3.09 KB	-rw-r--r--	2022-12-07 23:13
npm-org.md	1.01 KB	-rw-r--r--	2022-12-07 23:13
npm-outdated.md	3.77 KB	-rw-r--r--	2022-12-07 23:13
npm-owner.md	1.25 KB	-rw-r--r--	2022-12-07 23:13
npm-pack.md	948 B	-rw-r--r--	2022-12-07 23:13
npm-ping.md	726 B	-rw-r--r--	2022-12-07 23:13
npm-pkg.md.gz	1.8 KB	-rw-r--r--	2022-12-07 23:13
npm-prefix.md	839 B	-rw-r--r--	2022-12-07 23:13
npm-profile.md	2.9 KB	-rw-r--r--	2022-12-07 23:13
npm-prune.md	1.32 KB	-rw-r--r--	2022-12-07 23:13
npm-publish.md	3.58 KB	-rw-r--r--	2022-12-07 23:13
npm-query.md	2.84 KB	-rw-r--r--	2022-12-07 23:13
npm-rebuild.md	764 B	-rw-r--r--	2022-12-07 23:13
npm-repo.md	613 B	-rw-r--r--	2022-12-07 23:13
npm-restart.md	920 B	-rw-r--r--	2022-12-07 23:13
npm-root.md	686 B	-rw-r--r--	2022-12-07 23:13
npm-run-script.md.gz	1.72 KB	-rw-r--r--	2022-12-07 23:13
npm-search.md	1.56 KB	-rw-r--r--	2022-12-07 23:13
npm-shrinkwrap.md	938 B	-rw-r--r--	2022-12-07 23:13
npm-star.md	1007 B	-rw-r--r--	2022-12-07 23:13
npm-stars.md	690 B	-rw-r--r--	2022-12-07 23:13
npm-start.md	1.09 KB	-rw-r--r--	2022-12-07 23:13
npm-stop.md	791 B	-rw-r--r--	2022-12-07 23:13
npm-team.md	2.96 KB	-rw-r--r--	2022-12-07 23:13
npm-test.md	667 B	-rw-r--r--	2022-12-07 23:13
npm-token.md	3.31 KB	-rw-r--r--	2022-12-07 23:13
npm-uninstall.md	1.64 KB	-rw-r--r--	2022-12-07 23:13
npm-unpublish.md	1.47 KB	-rw-r--r--	2022-12-07 23:13
npm-unstar.md	866 B	-rw-r--r--	2022-12-07 23:13
npm-update.md	3.86 KB	-rw-r--r--	2022-12-07 23:13
npm-version.md	3.64 KB	-rw-r--r--	2022-12-07 23:13
npm-view.md	3.3 KB	-rw-r--r--	2022-12-07 23:13
npm-whoami.md	755 B	-rw-r--r--	2022-12-07 23:13
npm.md.gz	2.36 KB	-rw-r--r--	2022-12-07 23:13
npx.md.gz	2.16 KB	-rw-r--r--	2022-12-07 23:13

Rename

---
title: npm-publish
section: 1
description: Publish a package
---

### Synopsis

### Description

Publishes a package to the registry so that it can be installed by name.

By default npm will publish to the public registry. This can be
overridden by specifying a different default registry or using a
[`scope`](/using-npm/scope) in the name, combined with a
scope-configured registry (see
[`package.json`](/configuring-npm/package-json)).

A `package` is interpreted the same way as other commands (like
`npm install` and can be:

* a) a folder containing a program described by a
  [`package.json`](/configuring-npm/package-json) file
* b) a gzipped tarball containing (a)
* c) a url that resolves to (b)
* d) a `<name>@<version>` that is published on the registry (see
  [`registry`](/using-npm/registry)) with (c)
* e) a `<name>@<tag>` (see [`npm dist-tag`](/commands/npm-dist-tag)) that
  points to (d)
* f) a `<name>` that has a "latest" tag satisfying (e)
* g) a `<git remote url>` that resolves to (a)

The publish will fail 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 unpublish`](/commands/npm-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. Subsequent
installs will use the strongest supported algorithm to verify downloads.

Similar to `--dry-run` see [`npm pack`](/commands/npm-pack), which figures
out the files to be included and packs them into a tarball to be uploaded
to the registry.

### Files included in package

To see what will be included in your package, run `npx npm-packlist`.  All
files are included by default, with the following exceptions:

- Certain files that are relevant to package installation and distribution
  are always included.  For example, `package.json`, `README.md`,
  `LICENSE`, and so on.

- If there is a "files" list in
  [`package.json`](/configuring-npm/package-json), then only the files
  specified will be included.  (If directories are specified, then they
  will be walked recursively and their contents included, subject to the
  same ignore rules.)

- If there is a `.gitignore` or `.npmignore` file, then ignored files in
  that and all child directories will be excluded from the package.  If
  _both_ files exist, then the `.gitignore` is ignored, and only the
  `.npmignore` is used.

`.npmignore` files follow the [same pattern
  rules](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring)
  as `.gitignore` files

- If the file matches certain patterns, then it will _never_ be included,
  unless explicitly added to the `"files"` list in `package.json`, or
  un-ignored with a `!` rule in a `.npmignore` or `.gitignore` file.

- Symbolic links are never included in npm packages.

See [`developers`](/using-npm/developers) for full details on what's
included in the published package, as well as details on how the package is
built.

### Configuration

### See Also

* [package spec](/using-npm/package-spec)
* [npm-packlist package](http://npm.im/npm-packlist)
* [npm registry](/using-npm/registry)
* [npm scope](/using-npm/scope)
* [npm adduser](/commands/npm-adduser)
* [npm owner](/commands/npm-owner)
* [npm deprecate](/commands/npm-deprecate)
* [npm dist-tag](/commands/npm-dist-tag)
* [npm pack](/commands/npm-pack)
* [npm profile](/commands/npm-profile)