@cryptotaxi247 / documentation-1
Code Commits Issues Pulls Sessions CI/CD
reggi/dev-engines
@reggi/path-to-regexp dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2 dependabot/npm_and_yarn/main/eslint-10.4.0 dependabot/npm_and_yarn/main/npmcli/eslint-config-7.0.0 dependabot/npm_and_yarn/main/proc-log-7.0.0 dependabot/npm_and_yarn/npm_and_yarn-826852524d dependabot/npm_and_yarn/npm_and_yarn-ab9a7f4bc2 deprecate-totp-2fa dhei/classic-tokens gat-bypass-2fa-docs jpg619/fix-accessibility-content-flow jpg619/version-bump-tar-2 kartykp/gat-bypass-2fa-docs kartykp/upgrade-path-to-regex main maitxn/version-bump-tar patch-1 reggi/cache-based-on-version reggi/dev-engines reggi/fix-transform-prettier reggi/overrides update-search-sensitivity
mdx 200 lines 8.54 KB
Raw
1 ---
2 title: npm-publish
3 section: 1
4 description: Publish a package
5 github_repo: npm/cli
6 github_branch: latest
7 github_path: docs/lib/content/commands/npm-publish.md
8 redirect_from:
9 - /cli-commands/npm-publish
10 - /cli-commands/publish
11 - /cli-documentation/cli-commands/npm-publish
12 - /cli-documentation/cli-commands/publish
13 - /cli-documentation/commands/npm-publish
14 - /cli-documentation/commands/publish
15 - /cli-documentation/npm-publish
16 - /cli-documentation/publish
17 - /cli-documentation/v10/cli-commands/npm-publish
18 - /cli-documentation/v10/cli-commands/publish
19 - /cli-documentation/v10/commands/npm-publish
20 - /cli-documentation/v10/commands/publish
21 - /cli-documentation/v10/npm-publish
22 - /cli-documentation/v10/publish
23 - /cli/cli-commands/npm-publish
24 - /cli/cli-commands/publish
25 - /cli/commands/npm-publish
26 - /cli/commands/publish
27 - /cli/npm-publish
28 - /cli/publish
29 - /cli/v10/cli-commands/npm-publish
30 - /cli/v10/cli-commands/publish
31 - /cli/v10/commands/publish
32 - /cli/v10/npm-publish
33 - /cli/v10/publish
34 - /commands/npm-publish
35 - /commands/publish
36 ---
37
38 ### Synopsis
39
40 ```bash
41 npm publish <package-spec>
42 ```
43
44 ### Description
45
46 Publishes a package to the registry so that it can be installed by name.
47
48 By default npm will publish to the public registry. This can be overridden by specifying a different default registry or using a [`scope`](/cli/v10/using-npm/scope) in the name, combined with a scope-configured registry (see [`package.json`](/cli/v10/configuring-npm/package-json)).
49
50 A `package` is interpreted the same way as other commands (like `npm install`) and can be:
51
52 - a) a folder containing a program described by a [`package.json`](/cli/v10/configuring-npm/package-json) file
53 - b) a gzipped tarball containing (a)
54 - c) a url that resolves to (b)
55 - d) a `<name>@<version>` that is published on the registry (see [`registry`](/cli/v10/using-npm/registry)) with (c)
56 - e) a `<name>@<tag>` (see [`npm dist-tag`](/cli/v10/commands/npm-dist-tag)) that points to (d)
57 - f) a `<name>` that has a "latest" tag satisfying (e)
58 - g) a `<git remote url>` that resolves to (a)
59
60 The publish will fail if the package name and version combination already exists in the specified registry.
61
62 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`](/cli/v10/commands/npm-unpublish).
63
64 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.
65
66 Similar to `--dry-run` see [`npm pack`](/cli/v10/commands/npm-pack), which figures out the files to be included and packs them into a tarball to be uploaded to the registry.
67
68 ### Files included in package
69
70 To see what will be included in your package, run `npm pack --dry-run`. All files are included by default, with the following exceptions:
71
72 - Certain files that are relevant to package installation and distribution are always included. For example, `package.json`, `README.md`, `LICENSE`, and so on.
73
74 - If there is a "files" list in [`package.json`](/cli/v10/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.)
75
76 - 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.
77
78 `.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
79
80 - 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.
81
82 - Symbolic links are never included in npm packages.
83
84 See [`developers`](/cli/v10/using-npm/developers) for full details on what's included in the published package, as well as details on how the package is built.
85
86 ### Configuration
87
88 #### `tag`
89
90 - Default: "latest"
91 - Type: String
92
93 If you ask npm to install a package and don't tell it a specific version, then it will install the specified tag.
94
95 It is the tag added to the package@version specified in the `npm dist-tag add` command, if no explicit tag is given.
96
97 When used by the `npm diff` command, this is the tag used to fetch the tarball that will be compared with the local files by default.
98
99 If used in the `npm publish` command, this is the tag that will be added to the package submitted to the registry.
100
101 #### `access`
102
103 - Default: 'public' for new packages, existing packages it will not change the current level
104 - Type: null, "restricted", or "public"
105
106 If you do not want your scoped package to be publicly viewable (and installable) set `--access=restricted`.
107
108 Unscoped packages can not be set to `restricted`.
109
110 Note: This defaults to not changing the current access level for existing packages. Specifying a value of `restricted` or `public` during publish will change the access for an existing package the same way that `npm access set status` would.
111
112 #### `dry-run`
113
114 - Default: false
115 - Type: Boolean
116
117 Indicates that you don't want npm to make any changes and that it should only report what it would have done. This can be passed into any of the commands that modify your local installation, eg, `install`, `update`, `dedupe`, `uninstall`, as well as `pack` and `publish`.
118
119 Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc.
120
121 #### `otp`
122
123 - Default: null
124 - Type: null or String
125
126 This is a one-time password from a two-factor authenticator. It's needed when publishing or changing package permissions with `npm access`.
127
128 If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one.
129
130 #### `workspace`
131
132 - Default:
133 - Type: String (can be set multiple times)
134
135 Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option.
136
137 Valid values for the `workspace` config are either:
138
139 - Workspace names
140 - Path to a workspace directory
141 - Path to a parent workspace directory (will result in selecting all workspaces within that folder)
142
143 When set for the `npm init` command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.
144
145 This value is not exported to the environment for child processes.
146
147 #### `workspaces`
148
149 - Default: null
150 - Type: null or Boolean
151
152 Set to true to run the command in the context of **all** configured workspaces.
153
154 Explicitly setting this to false will cause commands like `install` to ignore workspaces altogether. When not set explicitly:
155
156 - Commands that operate on the `node_modules` tree (install, update, etc.) will link workspaces into the `node_modules` folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project, _unless_ one or more workspaces are specified in the `workspace` config.
157
158 This value is not exported to the environment for child processes.
159
160 #### `include-workspace-root`
161
162 - Default: false
163 - Type: Boolean
164
165 Include the workspace root when workspaces are enabled for a command.
166
167 When false, specifying individual workspaces via the `workspace` config, or all workspaces via the `workspaces` flag, will cause npm to operate only on the specified workspaces, and not on the root project.
168
169 This value is not exported to the environment for child processes.
170
171 #### `provenance`
172
173 - Default: false
174 - Type: Boolean
175
176 When publishing from a supported cloud CI/CD system, the package will be publicly linked to where it was built and published from.
177
178 This config can not be used with: `provenance-file`
179
180 #### `provenance-file`
181
182 - Default: null
183 - Type: Path
184
185 When publishing, the provenance bundle at the given path will be used.
186
187 This config can not be used with: `provenance`
188
189 ### See Also
190
191 - [package spec](/cli/v10/using-npm/package-spec)
192 - [npm-packlist package](http://npm.im/npm-packlist)
193 - [npm registry](/cli/v10/using-npm/registry)
194 - [npm scope](/cli/v10/using-npm/scope)
195 - [npm adduser](/cli/v10/commands/npm-adduser)
196 - [npm owner](/cli/v10/commands/npm-owner)
197 - [npm deprecate](/cli/v10/commands/npm-deprecate)
198 - [npm dist-tag](/cli/v10/commands/npm-dist-tag)
199 - [npm pack](/cli/v10/commands/npm-pack)
200 - [npm profile](/cli/v10/commands/npm-profile)