# @skivvy/skivvy-package-copy

> Copy files and folders

Latest version **0.1.4** (published 2015-08-31) · ISC license · 0 weekly downloads

## Install

```sh
npm install @skivvy/skivvy-package-copy
pnpm add @skivvy/skivvy-package-copy
yarn add @skivvy/skivvy-package-copy
bun add @skivvy/skivvy-package-copy
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2015-08-31 |
| First published | 2015-05-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Tim Kendrick |
| Maintainers | skivvy, timkendrick |
| Keywords | skivvy-package, copy, file, directory, folder |

## Links

- npm: https://www.npmjs.com/package/@skivvy/skivvy-package-copy
- Repository: https://github.com/skivvyjs/skivvy-package-copy
- Homepage: https://github.com/skivvyjs/skivvy-package-copy#readme
- Issues: https://github.com/skivvyjs/skivvy-package-copy/issues
- npm.io page: https://npm.io/package/@skivvy/skivvy-package-copy

## Dependencies (2)

- [promise](https://npm.io/package/promise.md) ^7.0.4
- [recursive-copy](https://npm.io/package/recursive-copy.md) ^1.0.9

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 0.1.4 (latest) — 2015-08-31
- 0.1.3 — 2015-06-10
- 0.1.2 — 2015-05-28
- 0.1.1 — 2015-05-26
- 0.1.0 — 2015-05-24
- 0.0.1 — 2015-05-23

## README

# Skivvy package: `copy`
[![npm version](https://img.shields.io/npm/v/@skivvy/skivvy-package-copy.svg)](https://www.npmjs.com/package/@skivvy/skivvy-package-copy)
![Stability](https://img.shields.io/badge/stability-stable-brightgreen.svg)
[![Build Status](https://travis-ci.org/skivvyjs/skivvy-package-copy.svg?branch=master)](https://travis-ci.org/skivvyjs/skivvy-package-copy)

> Copy files and folders


## Installation

```bash
skivvy install copy
```


## Overview

This package allows you to copy files and folders from within the [Skivvy](https://www.npmjs.com/package/skivvy) task runner.


## Included tasks

### `copy`

Copy files and folders

#### Usage:

```bash
skivvy run copy
```


#### Configuration settings:

| Name | Type | Required | Default | Description |
| ---- | ---- | -------- | ------- | ----------- |
| `source` | `string`,`Array` | Yes | N/A | Files/folders to copy |
| `destination` | `string` | Yes | N/A | Destination path |
| `options` | `object` | No | `{}` | Copy options |
| `options.overwrite` | `boolean` | No | `false` | Whether to overwrite destination files |
| `options.dot` | `boolean` | No | `false` | Whether to copy files beginning with a `.` |
| `options.junk` | `boolean` | No | `false` | Whether to copy OS junk files (e.g. `.DS_Store`, `Thumbs.db`) |
| `options.filter` | `function`, `RegExp`, `string`, `array` | No | `null` | Filter function / regular expression / glob that determines which files to copy |
| `options.rename` | `function` | No | `null` | Function that maps source paths to destination paths |
| `options.transform` | `function` | No | `null` | Function that returns a transform stream used to modify file contents |

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