# yeoman-remote

> Fetch a remote zip and extract it in a cache folder

Latest version **1.0.1** (published 2016-07-18) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install yeoman-remote
pnpm add yeoman-remote
yarn add yeoman-remote
bun add yeoman-remote
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2016-07-18 |
| First published | 2016-07-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | The Yeoman Team |
| Maintainers | sboudrias |
| Keywords | remote, fetch, yeoman, cache |

## Links

- npm: https://www.npmjs.com/package/yeoman-remote
- Repository: https://github.com/yeoman/yeoman-remote
- Homepage: https://github.com/yeoman/yeoman-remote#readme
- Issues: https://github.com/yeoman/yeoman-remote/issues
- npm.io page: https://npm.io/package/yeoman-remote

## Dependencies (5)

- [lodash](https://npm.io/package/lodash.md) ^4.13.1
- [rimraf](https://npm.io/package/rimraf.md) ^2.5.0
- [download](https://npm.io/package/download.md) ^4.4.3
- [xdg-basedir](https://npm.io/package/xdg-basedir.md) ^2.0.0
- [underscore.string](https://npm.io/package/underscore.string.md) ^3.2.2

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2016-07-18
- 1.0.0 — 2016-07-17

## README

# yeoman-remote [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage percentage][coveralls-image]][coveralls-url]

> Fetch packages and archives from remote resources with cache support

This package is a simplified export of the `yeoman-generator` `remote`, `fetch` and `extract` functions. Currently, the preferred way is to use `npm` to fetch github resources at install time. We're providing this package to ease transition to newer versions of `yeoman-generator`.

## Installation

```sh
$ npm install --save yeoman-remote
```

## Usage

```js
var remote = require('yeoman-remote');
var path = require('path');

module.exports = yeoman.Base.extend({
  writing: function () {
    var done = this.async();

    remote('yeoman', 'generator', function (cachePath) {
      this.fs.copy(
        path.join(cachePath, 'lib/index.js'),
        this.destinationPath('lib/index.js')
      );
      done();
    }.bind(this));
  }
});
```

`remote.fetch` and `remote.extract` methods are also available.

## License

MIT © [The Yeoman Team](http://yeoman.io)


[npm-image]: https://badge.fury.io/js/yeoman-remote.svg
[npm-url]: https://npmjs.org/package/yeoman-remote
[travis-image]: https://travis-ci.org/yeoman/yeoman-remote.svg?branch=master
[travis-url]: https://travis-ci.org/yeoman/yeoman-remote
[daviddm-image]: https://david-dm.org/yeoman/yeoman-remote.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/yeoman/yeoman-remote
[coveralls-image]: https://coveralls.io/repos/yeoman/yeoman-remote/badge.svg
[coveralls-url]: https://coveralls.io/r/yeoman/yeoman-remote

---
_Source: https://npm.io/package/yeoman-remote · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
