Cache Management for Faster Installs

Beginner6 min

Optimize npm install times by understanding, managing, and leveraging the npm cache for local development and CI pipelines.

Prerequisites

-Node.js and npm installed

Steps

View cache location and info

Find where npm stores its cache and check its current size.

$ npm cache ls 2>/dev/null; echo 'Cache path:' && npm config get cache && du -sh $(npm config get cache) 2>/dev/null || echo 'Cache size unavailable'

Verify cache integrity

Check that cached packages are not corrupted.

$ npm cache verify

This also garbage-collects unused cache entries, freeing disk space.

Clean the cache entirely

Remove all data from the npm cache when troubleshooting install issues.

$ npm cache clean --force

Only clean the cache when debugging install problems. Clearing it means all packages must be re-downloaded on next install.

Configure cache for CI

Set a custom cache directory for CI pipeline caching.

$ npm ci --cache .npm-cache

Point npm at a project-local cache directory that your CI system can persist between builds. This avoids re-downloading packages on every run.

Full Script

full-script.sh

#!/bin/bash
# npm Cache Optimization
set -euo pipefail

echo "=== Cache Info ==="
CACHE_DIR=$(npm config get cache)
echo "Location: $CACHE_DIR"

if [ -d "$CACHE_DIR" ]; then
  SIZE=$(du -sh "$CACHE_DIR" 2>/dev/null | cut -f1)
  echo "Size: $SIZE"
  ENTRIES=$(find "$CACHE_DIR" -name '*.tgz' 2>/dev/null | wc -l)
  echo "Cached packages: $ENTRIES"
else
  echo "Cache directory does not exist yet"
fi

echo ""
echo "=== Verifying Cache Integrity ==="
npm cache verify

echo ""
echo "=== Install Speed Test ==="
echo "With cache (warm):"
time npm install --prefer-offline 2>/dev/null || echo "Install completed"

echo ""
echo "=== CI Optimization Tips ==="
echo "1. Use 'npm ci' instead of 'npm install' in CI"
echo "2. Cache the npm cache directory between builds"
echo "3. Use '--prefer-offline' for faster installs with warm cache"
echo "4. Set a local cache: npm ci --cache .npm-cache"

FAQ

Discussion

Loading comments...

#!/bin/bash # npm Cache Optimization set -euo pipefail echo "=== Cache Info ===" CACHE_DIR=$(npm config get cache) echo "Location: $CACHE_DIR" if [ -d "$CACHE_DIR" ]; then SIZE=$(du -sh "$CACHE_DIR" 2>/dev/null | cut -f1) echo "Size: $SIZE" ENTRIES=$(find "$CACHE_DIR" -name '*.tgz' 2>/dev/null | wc -l) echo "Cached packages: $ENTRIES" else echo "Cache directory does not exist yet" fi echo "" echo "=== Verifying Cache Integrity ===" npm cache verify echo "" echo "=== Install Speed Test ===" echo "With cache (warm):" time npm install --prefer-offline 2>/dev/null || echo "Install completed" echo "" echo "=== CI Optimization Tips ===" echo "1. Use 'npm ci' instead of 'npm install' in CI" echo "2. Cache the npm cache directory between builds" echo "3. Use '--prefer-offline' for faster installs with warm cache" echo "4. Set a local cache: npm ci --cache .npm-cache"