sindresorhus/cpy-cli

Copy files

cpy-cli

Copy files

Why

• Fast by using streams.
• Resilient by using graceful-fs.
• User-friendly by accepting globs and creating non-existent destination directories.
• User-friendly error messages.

Install

npm install --global cpy-cli

Usage

$ cpy --help

  Usage
    $ cpy <source …> <destination>

  Options
    --no-overwrite       Don't overwrite the destination
    --cwd=<dir>          Working directory for files
    --rename=<filename>  Rename all <source> filenames to <filename>. Supports string templates.
    --dot                Allow patterns to match entries that begin with a period (.)
    --flat               Flatten directory structure. All copied files will be put in the same directory.
    --concurrency        Number of files being copied concurrently

  <source> can contain globs if quoted

  Examples
    Copy all .png files in src folder into dist except src/goat.png
    $ cpy 'src/*.png' '!src/goat.png' dist

    Copy all files inside src folder into dist and preserve path structure
    $ cpy . '../dist/' --cwd=src

    Copy all .png files in the src folder to dist and prefix the image filenames
    $ cpy 'src/*.png' dist --cwd=src --rename=hi-{{basename}}

Related

• cpy - API for this module

cpy-cli's Issues

`--cwd` flag does not work

Previously I was executing the following command with 3.1.x

cpy **/*.scss !**/*.stories.scss ../lib --parents --cwd=src

with a result similar to:

% ls lib/**/*.scss 
lib/Button/Button.scss
lib/ButtonLink/ButtonLink.scss
lib/Checkbox/Checkbox.scss

However, the 4.0 release doesn't find any files to copy. This seems like a globbing problem.

macOS problemam with subfolders

Platform

macOS monterey M1 Max processor Node 18.17.0 npm 9.6.7

If I define a script in package.json with

cpy 'prisma/parts/schema.prisma' 'prisma/'

and I run nom run script from the project root folder a prisma folder is created under the prisma folder in the project root

instead of copying schema.prisma from prisma/parts in prisma

Tested both 4.2.0 and 5.0.0, with version 3.1.1 the behaviour is correct

Help converting syntax for package.json script

I am using this for a build process that is simple enough to live strictly in NPM via scripts in package.json.

I have no problems using the tool when the syntax uses wildcards in directory; for example:

cpy ../../../shared/picker/*.min.js dist/js/vendor/

But it doesn't do anything (nor throw an actual error, mind you) when I try to single out just a specific file like this:

cpy ../../../shared/picker/picker.min.js dist/js/vendor/

I tried understanding how to translate the original API from "cpy", but the samples were Javascript function calls rather than passing arguments in the command line.

Is the single-file method not supported, or am I missing something in my syntax?

Add support for `concurrency` option

https://github.com/sindresorhus/cpy/releases/tag/v8.0.0

Readme examples don't work in windows powershell - have to use double quotes ("")

npx cpy-cli --nooverwrite produces an error when file exists. Expected skip

Platform

windows 11 22H2
[email protected]

When I execute

npx cpy-cli .\test.json foo\ --no-overwrite

it returns the error

Cannot copy from `test.json` to `d:\temp\foo\test.json`: 
Cannot write to `d:\temp\foo\test.json`: EEXIST: file already exists, open 'd:\temp\foo\test.json'

Issuing the command without --no-overwrite works fine (but the file is overwritten)

Expected

when setting the --no-overwrite parameter it should continue without error even if the file exists.

My Misunderstanding of purpose?

I found the test for cpy, it appears it is expected that overwrite:false will throw an exception? If so is there any way to 'skip/ignore' existing files similar to how the non async approach appears to work?

test('do not overwrite', async t => {
	fs.mkdirSync(t.context.tmp);
	fs.writeFileSync(path.join(t.context.tmp, 'license'), '');

	await t.throwsAsync(cpy(['license'], t.context.tmp, {overwrite: false}));

	t.is(read(t.context.tmp, 'license'), '');
});

EDIT: reading cp-file code, if I understand async copy overwrite false will throw an exception, but sync copy overwrite will not. If that is correct, then this was just a misunderstanding, please close the issue.

Broken after release on 2019-12-06

Source as just plain dot does not work anymore. Was forced to replace with "**". Not sure if any other formats could be broken.

Copy files to current directory

there is a way to copy the files to current directory?

--dot flag appears broken

Not entirely sure if this is related to #22, but the --dot flag appears to be non-functional on the latest version. The command:

cpy --dot *.{yml,yaml} dist

does not copy a .meshrc.yml file in the directory, but does copy both .yml and .yaml files without a leading . in the filename.

Enhancement: Copy if newer option

Would be helpful to have an option to only replace the destination if the source is different/newer.

.sh file permission changed?

I have a .sh file with +x permissions on it. When I copy it:

cpy \"**/*.sh\" \"../dist/\" --cwd=src --parents

it's execute permissions are stripped / not maintained.

Is it expected?

Thanks! Chad

option for ignore error if not found files

I run.

cpy 'public/**/*.*' '../build/' --cwd=src --parents

Output:

Cannot glob `public/**/*.*,!**/*-src.*`: Cannot copy from `/path/to/src/public/**/*.*` to `/path/to/build/public/**/*.*`: cannot read from `/path/to/public/**/*.*`: ENOENT: no such file or directory, open '/path/to/src/public/**/*.*'

Update dependency cpy to fix security advisory

npm audit has the following security advisory for cpy-cli:

  Moderate        Regular expression denial of service
  Package         glob-parent
  Patched in      >=5.1.2
  Dependency of   cpy-cli [dev]
  Path            cpy-cli > cpy > globby > fast-glob > glob-parent
  More info       https://npmjs.com/advisories/1751

link: https://npmjs.com/advisories/1751

It looks like this has already been fixed in your library cpy.
details: sindresorhus/cpy#84

Command lines with multiple sources fail in v3.0.0

After upgrading from 2 to 3, the following command fails:

$ cpy CHANGELOG.md CLASSES.md LICENSE README.md dist/
Cannot copy `CHANGELOG.md,CLASSES.md,LICENSE,README.md`: the file doesn't exist

CLI update to `cpy` API v6?

Currently locked on v4:
https://github.com/sindresorhus/cpy-cli/blob/master/package.json#L52

cpy-cli/package.json

Line 52 in a8d4be9

"cpy": "^4.0.0",

cpy API:
https://www.npmjs.com/package/cpy
https://unpkg.com/cpy/package.json
https://github.com/sindresorhus/cpy/blob/master/package.json

Initial folder structure not restored in destination folder

Hey 👋 First thanks for the effort put in this project 👍

I have a project structure that looks like this:

project
│
└───node_modules
│   └───module
│       └───public
│           └───dist
│               │ styles.css
│           │ index.html
│   
└───src

And I want to copy the public folder from node_modules/module/public into the src/public folder. So I run this command:

$ yarn cpy ./node_modules/module/public ./src/public

It works but the final src/public folder contains all the files but not the initial folder structure:

# just the files
│   
└───src
    └───public
        │ styles.css
        │ index.html

# expected folder structure
│   
└───src
    └───public
        └───dist
            │ styles.css
        │ index.html

And if I run it with the --parents I got this structure:

public
│
└───node_modules
│   └───module
│       └───public
│           └───dist
│               │ styles.css
│           │ index.html

Has someone an idea how I could get the expected folder structure?

Thanks in advance 😄

Add `--watch` option

I found this previous issue #11 that was withdrawn by the requester, but i still need it. None of the related tools work for me, since i specifically need to not preserve the directory structure, and cpy is the only node tool i've found that doesn't.

Cannot simply copy an entire folder

I am getting errors for all folder with this command

cpy test/dist somewhere

Cannot glob `test/dist/folder, test/dist/folder-2`:  EISDIR: illegal operation on a directory, read

I tried

cpy test/dist/**/* somewhere

but same result.

I understand why there is an error, but it's pretty weird to not be able to ignore folder, I would have make this the default behavior.

---

IssueHunt Summary

Backers (Total: $80.00)

• issuehunt ($80.00)

Submitted pull Requests

• #33 feat: bumped packages, using --up

---

Become a backer now!

Or submit a pull request to get the deposits!

Tips

• Checkout the Issuehunt explorer to discover more funded issues.
• Need some help from other developers? Add your repositories on IssueHunt to raise funds.

Please bump cpy package version.

Here is a vulnerability related to make-dir package which is used in version 9.1.0 of cp-file package.

At the moment the cpy-cli package depends on vulnerable version of cpy, since uses not the last version of that package.

The npm audit report gives the following output:

Thanks in advance.

[Minor] Windows Argument Escaping

For Windows users the --help examples are misleading, e.g.:

C:\test>dir src
…
07.10.2016  19:07                 0 goat.png
07.10.2016  19:07                 0 unicorn.png

C:\test>cpy --help
…
  Examples
    Copy all .png files in src folder into dist except src/goat.png
    $ cpy 'src/*.png' '!src/goat.png' dist

C:\test>cpy 'src/*.png' '!src/goat.png' dist
Cannot glob `'src/*.png','!src/goat.png'`: …

NB: Double quotes work as expected:

C:\test>cpy "src/*.png" "!src/goat.png" dist
C:\test>dir dist
…
07.10.2016  19:07                 0 unicorn.png

Not including dot files

Is there a way to include dot files (e.g., .editorconfig)?

npx cpy --rename=404.html build/index.html build

The command

npx cpy --rename=404.html build/index.html build

fails silently with version at least 4.2.0.

Works fine with 3.1.1

No errors on missing source

As the title implies, if the source folder doesn't exist, the cpy-cli doesn't complain/raise errors and does an exit(0) too.

Example:

npx cpy "./resources/fonts/*.*" "./public/fonts" --concurrency=20

Getting error `Only file and data URLs are supported by the default ESM loader` on Node v14.0.0-14.13.0 with [email protected]

It works fine in Node v12 and later versions of Node v14, but not Node v14.0.0 - 14.13.0.

$ npx [email protected] docs tests
npx: installed 100 in 1.747s
internal/modules/run_main.js:54
    internalBinding('errors').triggerUncaughtException(
                              ^

Error [ERR_UNSUPPORTED_ESM_URL_SCHEME]: Only file and data URLs are supported by the default ESM loader
    at Loader.defaultResolve [as _resolve] (internal/modules/esm/resolve.js:666:11)
    at Loader.resolve (internal/modules/esm/loader.js:97:40)
    at Loader.getModuleJob (internal/modules/esm/loader.js:243:28)
    at ModuleWrap.<anonymous> (internal/modules/esm/module_job.js:42:40)
    at link (internal/modules/esm/module_job.js:41:36) {
  code: 'ERR_UNSUPPORTED_ESM_URL_SCHEME'

[email protected] does work on all of those versions.

Not working with .env files

I am using version "cpy-cli": "^4.2.0",

I am trying to copy ".env.qa" contents to ".env" file in the same directory structure but its not working as intended. Instead of writing the contents, it creates a "/.env/.env.qa" directory & file.

I have tried the --dot and --flat flags but that doesn't solve the problem.

cpy .env.qa .env --dot --flat

I wanted to copy my environment variables from .env.qa or .env.production to .env file so it can be used with .dotenv package.

I wrestled with this api for like 30m. How do you do a `cp` style copy.

Seriously I'm not even using this module anymore I just want to know.

This is as close as I got after 30 minutes:
$ cpy .env.settings.sample cwd --rename .env.settings

Thanks

Add `nonull` to CLI param

Windows CI

With all the path handling stuff, I think, the CLI would profit from testing on Windows too.

@sindresorhus Would you mind to add support for Appveyor? At least for me, it's a bit cumbersome to run tests on Windows.

Btw, this may also be convenient for cpy and cp-file.

[Windows] not working in npm script if use '

If I use npm script
"copy": "cpy './package.json' dist"

npm run copy
it will give me error
Cannot copy './package.json': the file doesn't exist

But if I remove ' like this cpy ./package.json dist it will run correctly

Windows 10
Node 10.24.1

Inconsistent file tree depending on OS

Consider the following file tree:

dist-tmp
└── index.html

On Windows, the command npx cpy-cli dist-tmp/** dist/ results in:

dist
└── index.html

On Linux, the same command npx cpy-cli dist-tmp/** dist/ results in:

dist
└── dist-tmp
    └── index.html

It happened using node 18.18.0 on both systems

request: add option `--watch`

watch source dir and copy any changed/new files, like babel --watch or similar tools

edit: ah nevermind, found some other tools for this sync-glob, cpx, sync-files.

file already exists

We have .env and .env.development files in the C:\projects\xxx\.
Running cpy gives:

$ npx cpy './.env.development' './.env'
Cannot copy from `C:\projects\xxx\.env.development` to `C:\projects\xxx\.env\.env.development`: Cannot create directory `C:\projects\xxx\.env`: EEXIST: file already exists, mkdir 'C:\projects\xxx\.env'

Is that the expected result? Is there a workaround?
@sindresorhus

how to copy subfolder

oh, i see. use '**/*'

Usage in `package.json` script throws "const in script mode" error

When used in a package.json script, the script fails. For example:

  "scripts": {
    "bork": "cpy ./node_modules/font-awesome/fonts/* build/fonts/"
  },

C:\dev\test>npm run bork

> [email protected] bork C:\dev\test
> cpy ./node_modules/font-awesome/fonts/* build/fonts/

C:\dev\test\node_modules\cpy-cli\cli.js:3
const meow = require('meow');
^^^^^
SyntaxError: Use of const in strict mode.
    at exports.runInThisContext (vm.js:73:16)
    at Module._compile (module.js:443:25)
    at Object.Module._extensions..js (module.js:478:10)
    at Module.load (module.js:355:32)
    at Function.Module._load (module.js:310:12)
    at Function.Module.runMain (module.js:501:10)
    at startup (node.js:129:16)
    at node.js:814:3