Skip to content

Repository files navigation

gitget

📦 Clone GitHub repos fast and easy.


Usage

Console

# GitHub Repository# clone to /repo# (downloads the default branch of user/repo from GitHub)
$ npx gitget user/repo
# clone to /folder
$ npx gitget user/repo folder
# clone subfolder to /folder
$ npx gitget user/repo/subfolder folder
# specify a tag, branch or commit
$ npx gitget user/repo#dev # branch
$ npx gitget user/repo#v1.2.3 # release tag
$ npx gitget user/repo#1234abcd # commit hash# or simply copy and past the url from your browser# (downloads the subdir "core/conventional-commits/lib" from lerna/lerna#next)
$ npx gitget https://github.com/lerna/lerna/tree/next/core/conventional-commits/lib
# use the flag -i to only download information about the repo
$ npx gitget user/repo -i
# NPM Package# download npm package
$ npx gitget npm:packageName
# download npm package to /folder
$ npx gitget npm:packageName folder
# use the flag -i to only download information about the package
$ npx gitget npm:packageName -i

Node.js

interfaceGitGetOption{user?: stringrepo?: stringfolder?: stringsubdir?: string/** specify a tag, branch or commit */branch?: stringtest?: boolean/** silences steps (errors are still displayed) */silent?: boolean/** npm package name */npm?: string/** download only information instead */info?: boolean}
// index.cjsconst{ gitget }=require('gitget')gitget({ GitGetOptions })
// index.mjsimport{gitget}from'gitget/lib/gitget.js'gitget({ GitGetOptions })
// index.tsimport{gitget}from'gitget'gitget({ GitGetOptions })

Try it now!

Download Day.js for example.

# download the repository
$ npx gitget iamkun/dayjs
# download information about the repository
$ npx gitget iamkun/dayjs -i

Use npx gitget@latest ... if something is not working.

License

MIT

About

📦 Clone GitHub repos fast and easy.

Resources

Stars

10 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages