mirror of
https://github.com/oven-sh/bun
synced 2026-02-02 15:08:46 +00:00
b4f85c8866
## Summary Updated all example version placeholders in documentation from 1.3.1 and 1.2.20 to 1.3.2. ## Changes Updated version examples in: - Installation examples (Linux/macOS and Windows install commands) - Package manager output examples (`bun install`, `bun publish`, `bun pm` commands) - Test runner output examples - Spawn/child process output examples - Fetch User-Agent header examples in debugging docs - `Bun.version` API example ## Notes - Historical version references (e.g., "As of Bun v1.x.x..." or "Bun v1.x.x+ required") were intentionally **preserved** as they document when features were introduced - Generic package.json version examples (non-Bun package versions) were **preserved** - Only example outputs and code snippets showing current Bun version were updated ## Files Changed (13 total) - `docs/installation.mdx` - `docs/guides/install/from-npm-install-to-bun-install.mdx` - `docs/guides/install/add-peer.mdx` - `docs/bundler/html-static.mdx` (6 occurrences) - `docs/test/dom.mdx` - `docs/pm/cli/publish.mdx` - `docs/pm/cli/pm.mdx` - `docs/guides/test/snapshot.mdx` (2 occurrences) - `docs/guides/ecosystem/nuxt.mdx` - `docs/guides/util/version.mdx` - `docs/runtime/debugger.mdx` (3 occurrences) - `docs/runtime/networking/fetch.mdx` - `docs/runtime/child-process.mdx` **Total:** 23 version references updated 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Bot <claude-bot@bun.sh> Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Michael H <git@riskymh.dev>
124 lines
3.6 KiB
Plaintext
124 lines
3.6 KiB
Plaintext
---
|
|
title: "bun publish"
|
|
description: Use `bun publish` to publish a package to the npm registry
|
|
---
|
|
|
|
import Publish from "/snippets/cli/publish.mdx";
|
|
|
|
`bun publish` will automatically pack your package into a tarball, strip catalog and workspace protocols from the `package.json` (resolving versions if necessary), and publish to the registry specified in your configuration files. Both `bunfig.toml` and `.npmrc` files are supported.
|
|
|
|
```sh terminal icon="terminal"
|
|
## Publishing the package from the current working directory
|
|
bun publish
|
|
```
|
|
|
|
```txt
|
|
bun publish v1.3.2 (ca7428e9)
|
|
|
|
packed 203B package.json
|
|
packed 224B README.md
|
|
packed 30B index.ts
|
|
packed 0.64KB tsconfig.json
|
|
|
|
Total files: 4
|
|
Shasum: 79e2b4377b63f4de38dc7ea6e5e9dbee08311a69
|
|
Integrity: sha512-6QSNlDdSwyG/+[...]X6wXHriDWr6fA==
|
|
Unpacked size: 1.1KB
|
|
Packed size: 0.76KB
|
|
Tag: latest
|
|
Access: default
|
|
Registry: http://localhost:4873/
|
|
|
|
+ publish-1@1.0.0
|
|
```
|
|
|
|
Alternatively, you can pack and publish your package separately by using `bun pm pack` followed by `bun publish` with the path to the output tarball.
|
|
|
|
```sh terminal icon="terminal"
|
|
bun pm pack
|
|
...
|
|
bun publish ./package.tgz
|
|
```
|
|
|
|
<Note>
|
|
`bun publish` will not run lifecycle scripts (`prepublishOnly/prepack/prepare/postpack/publish/postpublish`) if a
|
|
tarball path is provided. Scripts will only be run if the package is packed by `bun publish`.
|
|
</Note>
|
|
|
|
### `--access`
|
|
|
|
The `--access` flag can be used to set the access level of the package being published. The access level can be one of `public` or `restricted`. Unscoped packages are always public, and attempting to publish an unscoped package with `--access restricted` will result in an error.
|
|
|
|
```sh terminal icon="terminal"
|
|
bun publish --access public
|
|
```
|
|
|
|
`--access` can also be set in the `publishConfig` field of your `package.json`.
|
|
|
|
```json package.json icon="file-json"
|
|
{
|
|
"publishConfig": {
|
|
"access": "restricted"
|
|
}
|
|
}
|
|
```
|
|
|
|
### `--tag`
|
|
|
|
Set the tag of the package version being published. By default, the tag is `latest`. The initial version of a package is always given the `latest` tag in addition to the specified tag.
|
|
|
|
```sh terminal icon="terminal"
|
|
bun publish --tag alpha
|
|
```
|
|
|
|
`--tag` can also be set in the `publishConfig` field of your `package.json`.
|
|
|
|
```json package.json icon="file-json"
|
|
{
|
|
"publishConfig": {
|
|
"tag": "next"
|
|
}
|
|
}
|
|
```
|
|
|
|
### `--dry-run`
|
|
|
|
The `--dry-run` flag can be used to simulate the publish process without actually publishing the package. This is useful for verifying the contents of the published package without actually publishing the package.
|
|
|
|
```sh terminal icon="terminal"
|
|
bun publish --dry-run
|
|
```
|
|
|
|
### `--gzip-level`
|
|
|
|
Specify the level of gzip compression to use when packing the package. Only applies to `bun publish` without a tarball path argument. Values range from `0` to `9` (default is `9`).
|
|
|
|
### `--auth-type`
|
|
|
|
If you have 2FA enabled for your npm account, `bun publish` will prompt you for a one-time password. This can be done through a browser or the CLI. The `--auth-type` flag can be used to tell the npm registry which method you prefer. The possible values are `web` and `legacy`, with `web` being the default.
|
|
|
|
```sh terminal icon="terminal"
|
|
bun publish --auth-type legacy
|
|
...
|
|
This operation requires a one-time password.
|
|
Enter OTP: 123456
|
|
...
|
|
```
|
|
|
|
### `--otp`
|
|
|
|
Provide a one-time password directly to the CLI. If the password is valid, this will skip the extra prompt for a one-time password before publishing. Example usage:
|
|
|
|
```sh terminal icon="terminal"
|
|
bun publish --otp 123456
|
|
```
|
|
|
|
<Note>
|
|
`bun publish` respects the `NPM_CONFIG_TOKEN` environment variable which can be used when publishing in github actions
|
|
or automated workflows.
|
|
</Note>
|
|
|
|
---
|
|
|
|
<Publish />
|