bun-types/docs/snippets/cli/install.mdx

Type definitions and documentation for Bun, an incredibly fast JavaScript runtime

## CLI Usage

```sh terminal icon="terminal"
bun install <name>@<version>
```

### General Configuration

<ParamField path="--config" type="string">
  Specify path to config file (bunfig.toml)
</ParamField>

<ParamField path="--cwd" type="string">
  Set a specific cwd
</ParamField>

### Dependency Scope & Management

<ParamField path="--production" type="boolean">
  Don't install devDependencies
</ParamField>

<ParamField path="--no-save" type="boolean">
  Don't update package.json or save a lockfile
</ParamField>

<ParamField path="--save" type="boolean" default="true">
  Save to package.json
</ParamField>

<ParamField path="--omit" type="string">
  Exclude 'dev', 'optional', or 'peer' dependencies from install
</ParamField>

<ParamField path="--only-missing" type="boolean">
  Only add dependencies to package.json if they are not already present
</ParamField>

### Dependency Type & Versioning

<ParamField path="--dev" type="boolean">
  Add dependency to "devDependencies"
</ParamField>

<ParamField path="--optional" type="boolean">
  Add dependency to "optionalDependencies"
</ParamField>

<ParamField path="--peer" type="boolean">
  Add dependency to "peerDependencies"
</ParamField>

<ParamField path="--exact" type="boolean">
  Add the exact version instead of the ^range
</ParamField>

### Lockfile Control

<ParamField path="--yarn" type="boolean">
  Write a yarn.lock file (yarn v1)
</ParamField>

<ParamField path="--frozen-lockfile" type="boolean">
  Disallow changes to lockfile
</ParamField>

<ParamField path="--save-text-lockfile" type="boolean">
  Save a text-based lockfile
</ParamField>

<ParamField path="--lockfile-only" type="boolean">
  Generate a lockfile without installing dependencies
</ParamField>

### Network & Registry Settings

<ParamField path="--ca" type="string">
  Provide a Certificate Authority signing certificate
</ParamField>

<ParamField path="--cafile" type="string">
  File path to Certificate Authority signing certificate
</ParamField>

<ParamField path="--registry" type="string">
  Use a specific registry by default, overriding .npmrc, bunfig.toml and environment variables
</ParamField>

### Installation Process Control

<ParamField path="--dry-run" type="boolean">
  Don't install anything
</ParamField>

<ParamField path="--force" type="boolean">
  Always request the latest versions from the registry & reinstall all dependencies
</ParamField>

<ParamField path="--global" type="boolean">
  Install globally
</ParamField>

<ParamField path="--backend" type="string" default="clonefile">
  Platform-specific optimizations: "clonefile", "hardlink", "symlink", "copyfile"
</ParamField>

<ParamField path="--filter" type="string">
  Install packages for the matching workspaces
</ParamField>

<ParamField path="--analyze" type="boolean">
  Analyze & install all dependencies of files passed as arguments recursively
</ParamField>

### Caching Options

<ParamField path="--cache-dir" type="string">
  Store & load cached data from a specific directory path
</ParamField>

<ParamField path="--no-cache" type="boolean">
  Ignore manifest cache entirely
</ParamField>

### Output & Logging

<ParamField path="--silent" type="boolean">
  Don't log anything
</ParamField>

<ParamField path="--verbose" type="boolean">
  Excessively verbose logging
</ParamField>

<ParamField path="--no-progress" type="boolean">
  Disable the progress bar
</ParamField>

<ParamField path="--no-summary" type="boolean">
  Don't print a summary
</ParamField>

### Security & Integrity

<ParamField path="--no-verify" type="boolean">
  Skip verifying integrity of newly downloaded packages
</ParamField>

<ParamField path="--trust" type="boolean">
  Add to trustedDependencies in the project's package.json and install the package(s)
</ParamField>

### Concurrency & Performance

<ParamField path="--concurrent-scripts" type="number" default="5">
  Maximum number of concurrent jobs for lifecycle scripts
</ParamField>

<ParamField path="--network-concurrency" type="number" default="48">
  Maximum number of concurrent network requests
</ParamField>

### Lifecycle Script Management

<ParamField path="--ignore-scripts" type="boolean">
  Skip lifecycle scripts in the project's package.json (dependency scripts are never run)
</ParamField>

### Help Information

<ParamField path="--help" type="boolean">
  Print this help menu
</ParamField>