UNPKG

gitpick

Version:

Clone exactly what you need aka straightforward project scaffolding!

github.com/nrjdalal/gitpick

nrjdalal/gitpick

138 lines (98 loc) • 4.9 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# 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) > #### Just `copy-and-paste` any GitHub URL - no editing required (shorthands work too) - to clone individual files, folders, branches, commits, raw content or even entire repositories without the `.git` directory. Unlike other tools that force you to tweak URLs or follow strict formats to clone files or folders, GitPick works seamlessly with any URL. <img width="400" alt="GitPick Meme" src="https://github.com/user-attachments/assets/180c3e5b-320c-48d7-aaf9-a7402e74c882" /> --- ## 📖 Some Examples ### See [Quick Usage](#-quick-usage) for to learn more. ```sh # clone a repo without .git npx gitpick owner/repo npx gitpick https://github.com/owner/repo # clone a folder aka tree npx gitpick owner/repo/tree/main/path/to/folder npx gitpick https://github.com/owner/repo/tree/main/path/to/folder # clone a file aka blob npx gitpick owner/repo/blob/main/path/to/file npx gitpick https://github.com/owner/repo/blob/main/path/to/file # clone a branch npx gitpick owner/repo -b canary npx gitpick https://github.com/owner/repo -b canary npx gitpick owner/repo/tree/canary npx gitpick https://github.com/owner/repo/tree/canary # clone a commit SHA npx gitpick owner/repo -b cc8e93 npx gitpick https://github.com/owner/repo/commit/cc8e93 # clone submodules npx gitpick owner/repo -r npx gitpick https://github.com/owner/repo -r # clone a private repo npx gitpick https://<token>@github.com/owner/repo ``` --- ## ✨ 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 <url/shorthand> [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/owner/repo # repo without .git npx gitpick owner/repo/tree/main/path/to/folder # a folder aka tree npx gitpick owner/repo/blob/main/path/to/file # a file aka blob npx gitpick <url/shorthand> # default git behavior npx gitpick <url/shorthand> [target] # with optional target npx gitpick <url/shorthand> -b [branch/SHA] # branch or commit SHA npx gitpick <url/shorthand> -o # overwrite if exists npx gitpick <url/shorthand> -r # clone submodules npx gitpick <url/shorthand> -w 30s # sync every 30 seconds npx gitpick https://<token>@github.com/owner/repo # private repository ``` <img width="720" alt="Image" src="https://github.com/user-attachments/assets/ddbc41b4-bfc6-4287-bb85-eb949d723591" /> --- ## 🔧 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://<token>@github.com/owner/repo ``` --- ## 📦 Install Globally (Optional) ```sh npm install -g gitpick gitpick <url/shorthand> [target] [options] ``` --- ## 🛠 More Tools Check out more projects at [github.com/nrjdalal](https://github.com/nrjdalal) ## 🔗 Related Projects - [degit](https://github.com/tiged/tiged) - community driven fork of degit - [giget](https://github.com/unjs/giget) - alternative approach ## 📄 License MIT – [LICENSE](LICENSE)