---
title: npm_install
description: Install project dependencies with managed npm.
---

# `npm_install`

`npm_install` installs dependencies at project root with npm bundled in the selected Node.js distribution. It registers installation as a root task and returns a dependency for commands that must wait for installed packages.

Project-root `package.json` must be a regular, non-symlink file after dependencies finish. Root-package workspaces are supported. Installation is always project-local.

## Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `frozen_lockfile` | No | Run `npm ci` instead of `npm install`. Defaults to `False`. |
| `omit` | No | Unique dependency types to omit: `"dev"`, `"optional"`, or `"peer"`. Defaults to `[]`. |
| `ignore_scripts` | No | Disable package lifecycle scripts. Defaults to `False`. |
| `audit` | No | Enable npm's audit request. Defaults to `True`. |
| `deps` | No | Dependencies activated before installation, in list order. Defaults to `[]`. |

`npm ci` removes existing `node_modules`, requires a lockfile consistent with `package.json`, and does not update package metadata or lockfiles. Lifecycle scripts can run package-supplied code. npm audit sends dependency information to the configured registry.

The function reserves `node_modules`, `package-lock.json`, and `npm-shrinkwrap.json`, so declare it once per project execution.

## Examples

### Install project dependencies

```python
load("@nodejs@22.14.0", "npm_install")

npm_install()
```

### Reproduce a lockfile install

```python
load("@nodejs@22.14.0", "npm_install")

npm_install(
    frozen_lockfile=True,
    audit=False,
)
```

### Install production dependencies without lifecycle scripts

```python
load("@nodejs@22.14.0", "npm_install")

npm_install(
    frozen_lockfile=True,
    omit=["dev", "optional"],
    ignore_scripts=True,
    audit=False,
)
```

<!--
Sitemap

URL: https://withxx.dev/index.md
Title: xx
Description: Practical, reproducible builds without build-system ceremony

URL: https://withxx.dev/examples/commands.md
Title: Command Examples
Description: General command, environment, and entrypoint patterns.

URL: https://withxx.dev/examples/go.md
Title: Go Examples
Description: Common Go build patterns with managed SDKs.

URL: https://withxx.dev/examples/nodejs.md
Title: Node.js Examples
Description: Common Node.js task patterns with a managed distribution.

URL: https://withxx.dev/examples/zig.md
Title: Zig Examples
Description: Direct Zig commands and Go CGO builds with a managed Zig distribution.

URL: https://withxx.dev/load.md
Title: Loading Files
Description: Split xx configuration into local Starlark modules.

URL: https://withxx.dev/packages/go/go.md
Title: go
Description: Activate a managed Go SDK for dependent tasks.

URL: https://withxx.dev/packages/go/go_binary.md
Title: go_binary
Description: Build a Go command with a managed SDK.

URL: https://withxx.dev/packages/go/go_install.md
Title: go_install
Description: Install a versioned Go command for dependent tasks.

URL: https://withxx.dev/packages/go/go_run.md
Title: go_run
Description: Run a versioned Go command with a managed SDK.

URL: https://withxx.dev/packages/go/go_test.md
Title: go_test
Description: Test Go packages with a managed SDK.

URL: https://withxx.dev/packages/nodejs/nodejs.md
Title: nodejs
Description: Activate managed Node.js for dependent tasks.

URL: https://withxx.dev/packages/nodejs/npm_install.md
Title: npm_install
Description: Install project dependencies with managed npm.

URL: https://withxx.dev/packages/nodejs/npm_run.md
Title: npm_run
Description: Run a project package script with managed npm.

URL: https://withxx.dev/packages/nodejs/npx_run.md
Title: npx_run
Description: Run a versioned npm package command with managed npx.

URL: https://withxx.dev/packages/os/env_append.md
Title: env_append
Description: Append an item to a list-like environment variable.

URL: https://withxx.dev/packages/os/env_get.md
Title: env_get
Description: Read a value from a task environment while evaluating Starlark.

URL: https://withxx.dev/packages/os/env_prepend.md
Title: env_prepend
Description: Prepend an item to a list-like environment variable.

URL: https://withxx.dev/packages/os/env_set.md
Title: env_set
Description: Set an environment variable for dependent tasks.

URL: https://withxx.dev/packages/os/env_unset.md
Title: env_unset
Description: Remove an environment variable from dependent tasks.

URL: https://withxx.dev/packages/os/run.md
Title: run
Description: Run a command from the project root.

URL: https://withxx.dev/packages/zig/zig.md
Title: zig
Description: Activate managed Zig for dependent tasks.

URL: https://withxx.dev/packages/zig/zig_cc.md
Title: zig_cc
Description: Configure managed Zig as a C and C++ compiler.

URL: https://withxx.dev/packages.md
Title: Built-in Packages
Description: Versioned toolchains, commands, and task environment helpers provided by xx.
-->