ploff helps you clone a remote repository and copy parts of it locally. It's like git clone but with a few extra features.

Usage

Install the package globally:

$ npm install --global ploff
# OR
$ yarn global add ploff
# OR
$ pnpm add -g ploff

Then run the CLI:

# Clone a remote repository and copy it locally
$ ploff https://github.com/git/git.git

You can also use npx npx to run ploff without installing it:

$ npx ploff https://github.com/git/git.git

CLI

ploff has a few options you can use to customize the clone process:

<argument>: The remote repository URL.

# This will download the entire repository to the current directory
$ npx ploff https://github.com/git/git.git

-b or --branch - Specify a branch to clone. Defaults to main or master.

# Download the `develop` branch of the repository
$ npx ploff https://github.com/git/git.git -b develop

-o or --origin - Specify a directory or file that you want to grab from the remote repository.

# Copy the `builtin` directory from the remote repository to the current directory
$ npx ploff https://github.com/git/git.git -o builtin

# Copy the `Makefile` file from the remote repository to the current directory

$ npx ploff https://github.com/git/git.git -o Makefile

-t or --target - Specify where you should copy the origin to. Defaults to the current directory.

# Copy the `builtin` directory from the remote repository to the `src` directory

$ npx ploff  https://github.com/git/git.git -o builtin -t src

-h or --help - Show the help message.

-v or --version - Show the version number.