An open API service indexing awesome lists of open source software.

https://github.com/nrjdalal/gitpick

Clone exactly what you need aka straightforward project scaffolding!
https://github.com/nrjdalal/gitpick

clone degit directory file folder git github repository scaffolding template url

Last synced: 7 months ago
JSON representation

Clone exactly what you need aka straightforward project scaffolding!

Awesome Lists containing this project

README

          

# GitPick

**Clone exactly what you need aka straightforward project scaffolding!**

📦 `Zero dependencies` / `Un/packed (<35/15kb)` / `Faster and more features` yet drop-in replacement for `degit`

[![Twitter](https://img.shields.io/twitter/follow/nrjdalal_com?label=%40nrjdalal_com)](https://twitter.com/nrjdalal_com)
[![npm](https://img.shields.io/npm/v/gitpick?color=red&logo=npm)](https://www.npmjs.com/package/gitpick)
[![downloads](https://img.shields.io/npm/dt/gitpick?color=red&logo=npm)](https://www.npmjs.com/package/gitpick)
[![stars](https://img.shields.io/github/stars/nrjdalal/gitpick?color=blue)](https://github.com/nrjdalal/gitpick)

GitPick Meme

---

## ✨ Features

- 🔍 Clone individual files or folders from any GitHub repository
- ⚙️ Auto-detects branches and target directory (if not specified) like `git clone`
- 🧠 Use shorthands `TanStack/router` or full URL's `https://github.com/TanStack/router`
- 🗑️ Overwrite or replace existing files without a prompt using `-o` | `--overwrite`
- 📦 Can easily clone all submodules with `-r` | `--recursive`
- 🔁 Sync changes remotely with `--watch` using intervals (e.g., `15s`, `1m`, `1h`)
- 🔐 Seamlessly works with both public and private repositories using a PAT

---

## 🚀 Quick Usage

```sh
npx gitpick [target] [options]
```

- [target] and [options] are optional, if not specified, GitPick fallbacks to the default behavior of `git clone`

Examples:

```sh
npx gitpick https://github.com/TanStack/router # repo without .git
npx gitpick TanStack/router/tree/main/examples # a folder aka tree
npx gitpick TanStack/router/blob/main/README.md # a file aka blob

npx gitpick # default git behavior
npx gitpick [target] # with optional target
npx gitpick -b [branch/SHA] # branch or commit SHA
npx gitpick -o # overwrite if exists
npx gitpick -r # clone submodules
npx gitpick -w 30s # sync every 30 seconds
npx gitpick https://@github.com/owner/repo # private repository
```

Image

---

## 🔧 Options

```
-b, --branch Branch/SHA to clone
-o, --overwrite Skip overwrite prompt
-r, --recursive Clone submodules
-w, --watch [time] Watch the repository and sync every [time]
(e.g. 1h, 30m, 15s)
-h, --help display help for command
-v, --version display the version number
```

---

## 🔐 Private Repos

Use a [GitHub personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#about-personal-access-tokens) (create one 👉 [here](https://github.com/settings/personal-access-tokens/new)) with `repo -> contents: read-only` permission:

```sh
npx gitpick https://@github.com/owner/repo
```

---

## 📦 Install Globally (Optional)

```sh
npm install -g gitpick
gitpick [target] [options]
```

---

## 🛠 More Tools

Check out more projects at [github.com/nrjdalal](https://github.com/nrjdalal)

## 📄 License

MIT – [LICENSE](LICENSE)