Pkgcache NPM | npm.io

pkgcache

pkgcache is a command line utility that caches dependencies installed via npm, bower, and composer.

npm install -g pkgcache

Summary

pkgcache can be a drop-in replacement for any build script that runs [npm|bower|composer] install.

It is useful for build processes that run [npm|bower|composer] install every time as part of their build process. Since dependencies don't change often, this often means slower build times. pkgcache helps alleviate this problem by caching previously installed dependencies on the build machine.

How It Works

When you run pkgcache install [npm|bower|composer], it first looks for package.json, bower.json, or composer.json in the current working directory depending on which dependency manager is requested.
It then calculates the MD5 hash of the configuration file and looks for a filed named .tar.gz in the cache directory ($HOME/.pkgcache/ by default).
If the file does not exist, pkgcache uses the system's installed dependency manager to install the dependencies.
Once the dependencies are installed, pkgcache tars the newly downloaded dependencies and stores them in the cache directory.
If S3 is enabled via .pkgcache.json, the tarball is uploaded.
The next time pkgcache runs and sees the same config file hash calculation, it will find the tarball in the cache directory and untar the dependencies in the current working directory.
If it’s unavailable in $HOME/.pkgcache/ and S3 is enabled, attempt to download it from S3.

How `pkgcache` Differs from the Original `npm-cache`

The package cache directory structure includes the OS name and node version (if relaying npm).
The dependencies and devDependencies are sorted before calculating a hash so the order does not effect the hash.
Optionally use AWS S3 to share your cache among developers and continuous intergration. Put a .pkgcache.json in your project directory. E.g.:

{
  "accessKeyId": "...",
  "secretAccessKey": "...",
  "bucketName": "..."
}

Usage

pkgcache install

To specify arguments to each dependency manager, add the arguments after listing the dependency manager.

For example, to install bower components with the --allow-root option, and composer with the --dry-run option:

pkgcache install bower --allow-root composer --dry-run

Examples

Install npm, bower, and composer components simultaneously.

pkgcache install

Install only bower components.

pkgcache install bower

Install bower and npm components.

pkgcache install bower npm

Install bower with --allow-root and composer with --dry-run.

pkgcache install bower --allow-root composer --dry-run

Install bower components using /home/cache as the cache directory.

pkgcache install --cacheDirectory /home/cache/ bower

Force refresh a bower installation.

pkgcache install --forceRefresh bower

Clear the entire local $HOME/.pkgcache/ directory.

pkgcache clean

Cache Directory Structure

An example of how the tarballs are organized.

~/.pkgcache/
├── bower
│   └── project-one
│       └── 1.6.8
│           └── 7fed9e4deb7eba0c6686ac5d56c5561a.tar.gz
│           └── 7fed9e4deb7eba0c6686ac5d56c5561a.json
└── npm
    ├── project-one
    │   └── OS-X-Mavericks
    │       └── node-v0.12.7
    │           └── npm-2.11.3
    │               └── 5ea97f7c280ad42d0eefd50d03ed120e.tar.gz
    │               └── 5ea97f7c280ad42d0eefd50d03ed120e.json
    └── project-two
        └── OS-X-Mavericks
            ├── node-v0.12.7
            │   └── npm-2.11.3
            │       └── 38b13ac506b229325aa7207e601c11d5.tar.gz
            │       └── 38b13ac506b229325aa7207e601c11d5.json
            └── node-v4.2.3
                └── npm-3.5.2
                    └── 38b13ac506b229325aa7207e601c11d5.tar.gz
                    └── 38b13ac506b229325aa7207e601c11d5.json

Managing Archives

Local Archives

A meta file accompanies each tarball that contains the following information:

packageVersion is the version number from the config file
hash matches the filename hash
origin - whether the archive was created by internet installation or s3
date - when the archive was built
size - file size in human readable format
definition - the source for the hash

Example:

{
  "packageVersion": "1.1.0",
  "hash": "5d3129a53232e136103bad41da0544ac",
  "origin": "internet",
  "date": "2015-12-31T17:28:46-05:00",
  "size": "2.44MB",
  "definition": {
    "dependencies": {
      "moment": "^2.10.3",
      "serve-static": "^1.10.0",
      "express": "4.13.0"
    },
    "devDependencies": {
      "gulp": "^3.9.0",
      "del": "^2.2.0"
    }
  }
}