Copy files or directories from a GitHub repository path into a local folder — no full clone, no git history.

Execute with npx Node.js package manager quick package executable and copy over from a source user or organization repository to the local directory

npx gh-cp user/repo/.github/workflows .

Note: you can also execute with pnpm via: pnpm dlx gh-cp

Install globally with pnpm or with npm:

# install with pnpm globally
pnpm add -g gh-cp

# or install with npm globally
npm install -g gh-cp

Requirements: Node.js 24+. Optional but recommended: GitHub CLI (gh) and/or git on your PATH for auth and fewer HTTPS rate limits.

# Copy a repo subtree into the current directory (like cp -r repo/.devcontainer .)
npx gh-cp lirantal/npq/.devcontainer .

# Explicit destination and branch
npx gh-cp cli/cli --path ./upstream --ref trunk

# Preview and machine-readable summary
npx gh-cp cli/cli/README.md --dry-run --verbose
npx gh-cp cli/cli/README.md --json .

# Save a reusable source and install from it later
npx gh-cp alias devcontainer github.com/lirantal/create-node-lib/tree/main/template/.devcontainer/
npx gh-cp alias list
npx gh-cp install devcontainer .
npx gh-cp install

On success, gh-cp prints a short stdout summary (for example ✔︎ copied …) unless you pass --json (then only JSON is printed). Errors go to stderr with the version and a clear reason when the repo path or ref is wrong. See CLI output & errors.

Source syntax: owner/repo[/path][#ref] (also supports GitHub web path forms like owner/repo/blob/ref/path). Details: docs/features/source-spec.md.

Save frequently used sources as aliases:

npx gh-cp alias devcontainer github.com/lirantal/create-node-lib/tree/main/template/.devcontainer/

List saved aliases:

npx gh-cp alias list

Install directly from an alias:

npx gh-cp install devcontainer .

Run npx gh-cp install without an alias name to choose from saved aliases in a built-in interactive menu. The menu uses Node.js TTY APIs, so it only runs in an interactive terminal; pass an alias name when scripting or using --json. See Aliases and install.

• docs/README.md — overview and feature index
• Aliases and install — save reusable sources and choose them interactively
• CLI output & errors — success line, stderr errors, exit codes
• Authentication & strategies — gh → git → HTTPS order

Please consult CONTRIBUTING for guidelines on contributing to this project.

gh-cp © Liran Tal, Released under the Apache-2.0 License.