bun-types

The `bun pm` command group provides a set of utilities for working with Bun's package manager. ## pack To create a tarball of the current workspace: ```bash $ bun pm pack ``` This command creates a `.tgz` file containing all files that would be published to npm, following the same rules as `npm pack`. ## Examples Basic usage: ```bash $ bun pm pack # Creates my-package-1.0.0.tgz in current directory ``` Quiet mode for scripting: ```bash $ TARBALL=$(bun pm pack --quiet) $ echo "Created: $TARBALL" # Output: Created: my-package-1.0.0.tgz ``` Custom destination: ```bash $ bun pm pack --destination ./dist # Saves tarball in ./dist/ directory ``` ## Options - `--dry-run`: Perform all tasks except writing the tarball to disk. Shows what would be included. - `--destination <dir>`: Specify the directory where the tarball will be saved. - `--filename <name>`: Specify an exact file name for the tarball to be saved at. - `--ignore-scripts`: Skip running pre/postpack and prepare scripts. - `--gzip-level <0-9>`: Set a custom compression level for gzip, ranging from 0 to 9 (default is 9). - `--quiet`: Only output the tarball filename, suppressing verbose output. Ideal for scripts and automation. > **Note:** `--filename` and `--destination` cannot be used at the same time. ## Output Modes **Default output:** ```bash $ bun pm pack bun pack v1.2.19 packed 131B package.json packed 40B index.js my-package-1.0.0.tgz Total files: 2 Shasum: f2451d6eb1e818f500a791d9aace80b394258a90 Unpacked size: 171B Packed size: 249B ``` **Quiet output:** ```bash $ bun pm pack --quiet my-package-1.0.0.tgz ``` The `--quiet` flag is particularly useful for automation workflows where you need to capture the generated tarball filename for further processing. ## bin To print the path to the `bin` directory for the local project: ```bash $ bun pm bin /path/to/current/project/node_modules/.bin ``` To print the path to the global `bin` directory: ```bash $ bun pm bin -g <$HOME>/.bun/bin ``` ## ls To print a list of installed dependencies in the current project and their resolved versions, excluding their dependencies. ```bash $ bun pm ls /path/to/project node_modules (135) ├── eslint@8.38.0 ├── react@18.2.0 ├── react-dom@18.2.0 ├── typescript@5.0.4 └── zod@3.21.4 ``` To print all installed dependencies, including nth-order dependencies. ```bash $ bun pm ls --all /path/to/project node_modules (135) ├── @eslint-community/eslint-utils@4.4.0 ├── @eslint-community/regexpp@4.5.0 ├── @eslint/eslintrc@2.0.2 ├── @eslint/js@8.38.0 ├── @nodelib/fs.scandir@2.1.5 ├── @nodelib/fs.stat@2.0.5 ├── @nodelib/fs.walk@1.2.8 ├── acorn@8.8.2 ├── acorn-jsx@5.3.2 ├── ajv@6.12.6 ├── ansi-regex@5.0.1 ├── ... ``` ## whoami Print your npm username. Requires you to be logged in (`bunx npm login`) with credentials in either `bunfig.toml` or `.npmrc`: ```bash $ bun pm whoami ``` ## hash To generate and print the hash of the current lockfile: ```bash $ bun pm hash ``` To print the string used to hash the lockfile: ```bash $ bun pm hash-string ``` To print the hash stored in the current lockfile: ```bash $ bun pm hash-print ``` ## cache To print the path to Bun's global module cache: ```bash $ bun pm cache ``` To clear Bun's global module cache: ```bash $ bun pm cache rm ``` ## migrate To migrate another package manager's lockfile without installing anything: ```bash $ bun pm migrate ``` ## untrusted To print current untrusted dependencies with scripts: ```bash $ bun pm untrusted ./node_modules/@biomejs/biome @1.8.3 » [postinstall]: node scripts/postinstall.js These dependencies had their lifecycle scripts blocked during install. ``` ## trust To run scripts for untrusted dependencies and add to `trustedDependencies`: ```bash $ bun pm trust <names> ``` Options for the `trust` command: - `--all`: Trust all untrusted dependencies. ## default-trusted To print the default trusted dependencies list: ```bash $ bun pm default-trusted ``` see the current list on GitHub [here](https://github.com/oven-sh/bun/blob/main/src/install/default-trusted-dependencies.txt) ## version To display current package version and help: ```bash $ bun pm version bun pm version v1.2.22 (ca7428e9) Current package version: v1.0.0 Increment: patch 1.0.0 → 1.0.1 minor 1.0.0 → 1.1.0 major 1.0.0 → 2.0.0 prerelease 1.0.0 → 1.0.1-0 prepatch 1.0.0 → 1.0.1-0 preminor 1.0.0 → 1.1.0-0 premajor 1.0.0 → 2.0.0-0 from-git Use version from latest git tag 1.2.3 Set specific version Options: --no-git-tag-version Skip git operations --allow-same-version Prevents throwing error if version is the same --message=<val>, -m Custom commit message, use %s for version substitution --preid=<val> Prerelease identifier (i.e beta → 1.0.1-beta.0) --force, -f Bypass dirty git history check Examples: $ bun pm version patch $ bun pm version 1.2.3 --no-git-tag-version $ bun pm version prerelease --preid beta --message "Release beta: %s" ``` To bump the version in `package.json`: ```bash $ bun pm version patch v1.0.1 ``` Supports `patch`, `minor`, `major`, `premajor`, `preminor`, `prepatch`, `prerelease`, `from-git`, or specific versions like `1.2.3`. By default creates git commit and tag unless `--no-git-tag-version` was used to skip. ## pkg Manage `package.json` data with get, set, delete, and fix operations. All commands support dot and bracket notation: ```bash scripts.build # dot notation contributors[0] # array access workspaces.0 # dot with numeric index scripts[test:watch] # bracket for special chars ``` Examples: ```bash # set $ bun pm pkg get name # single property $ bun pm pkg get name version # multiple properties $ bun pm pkg get # entire package.json $ bun pm pkg get scripts.build # nested property # set $ bun pm pkg set name="my-package" # simple property $ bun pm pkg set scripts.test="jest" version=2.0.0 # multiple properties $ bun pm pkg set {"private":"true"} --json # JSON values with --json flag # delete $ bun pm pkg delete description # single property $ bun pm pkg delete scripts.test contributors[0] # multiple/nested # fix $ bun pm pkg fix # auto-fix common issues ```