https://github.com/elsehow/ipfs-shrinkwrap

Shrinkwrap your npm dependencies with IPFS
https://github.com/elsehow/ipfs-shrinkwrap

Last synced: about 1 month ago
JSON representation

Shrinkwrap your npm dependencies with IPFS

• Host: GitHub
• URL: https://github.com/elsehow/ipfs-shrinkwrap
• Owner: elsehow
• Created: 2016-06-09T20:48:07.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-11-05T22:42:13.000Z (over 7 years ago)
• Last Synced: 2025-03-25T17:49:06.862Z (about 2 months ago)
• Language: JavaScript
• Homepage: http://gateway.ipfs.io/ipfs/Qmekvk5cCHyvnMQKNf8qJCgANhsdD7vEgJnBQYGhzhWk7K
• Size: 7.81 KB
• Stars: 6
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ipfs-shrinkwrap

[![ipfs-shrinkwrap](https://ipfs.pics/ipfs/QmXV8a5eSGeKBCQjFzsMGyYmoYvshyX8SYBb9JCTEsr7gE)](https://github.com/elsehow/ipfs-shrinkwrap)

Shrinkwrap your npm dependencies by backing them up to IPFS.

**WARNING** This is a WIP. Shrinkwrapped dependencies may contain information about your system, e.g. your path or other environment info. *Use at your own risk!* (thanks @clkao).

## install

    npm install -g ipfs-shrinkwrap

## use

First, run an [IPFS daemon](https://ipfs.io/).

### Shrinkwrapping your dependencies

Make sure you have a `node_modules/` directory with all the deps you want to shinkwrap. Then,

    ipfs-shrinkwrap

This will add a field "ipfs-shrinkwrap" to your `package.json`.

Re-run this command whenever your dependencies change, and the IPFS hash in `package.json` will be updated to point at the new dependencies.

### Installing dependencies from IPFS

To install your dependencies from ipfs (rather than npm), just

    ipfs-shrinkwrap install

This will install all this package's dependencies into `node_modules/`

## ipfs-shrinkwrap lifestyle

Add a badge to your project!

[![ipfs-shrinkwrap](https://ipfs.pics/ipfs/QmXV8a5eSGeKBCQjFzsMGyYmoYvshyX8SYBb9JCTEsr7gE)](https://github.com/elsehow/ipfs-shrinkwrap)

```markdown

[![ipfs-shrinkwrap](https://ipfs.pics/ipfs/QmXV8a5eSGeKBCQjFzsMGyYmoYvshyX8SYBb9JCTEsr7gE)](https://github.com/elsehow/ipfs-shrinkwrap)

```

Keep your shinkwrap up to date, automatically! Add ipfs-shrinkwrap to the prepublish hook in your package.json:

```

{ 

  scripts: {

    "prepublish": "ipfs-shrinkwrap"

  }

}

```

## license

BSD