Awesome fork of degit. Please join our discord <- new fixed link.
tiged makes copies of git repositories. When you run tiged some-user/some-repo or (for backward compatibility) degit some-user/some-repo, it will find the latest commit on https://github.com/some-user/some-repo and download the associated tar file to ~/.degit/some-user/some-repo/commithash.tar.gz if it doesn't already exist locally. (This is much quicker than using git clone, because you're not downloading the entire git history.)
npm uninstall -g degit
npm install -g tigedYou can use tiged or degit as the command. So no automated scripts break if you swap degit for tiged.
The simplest use of tiged is to download the main branch of a repo from GitHub to the current working directory:
tiged user/repo
# these commands are equivalent
tiged github:user/repo
tiged git@github.com:user/repo
tiged https://github.com/user/repoOr you can download from GitLab, BitBucket, Sourcehut, Hugging Face, and Codeberg:
# download from GitLab
tiged gitlab:user/repo
tiged git@gitlab.com:user/repo
tiged https://gitlab.com/user/repo
# download from BitBucket
tiged bitbucket:user/repo
tiged git@bitbucket.org:user/repo
tiged https://bitbucket.org/user/repo
# download from Sourcehut
tiged git.sr.ht/user/repo
tiged git@git.sr.ht:user/repo
tiged https://git.sr.ht/user/repo
# download from Hugging Face
tiged huggingface:user/repo
tiged git@huggingface.co:user/repo
tiged https://huggingface.co/user/repo
# download from Codeberg
tiged codeberg:user/repo
tiged git@codeberg.org:user/repo
tiged https://codeberg.org/user/repotiged user/repo#dev # branch
tiged user/repo#v1.2.3 # release tag
tiged user/repo#1234abcd # commit hashIf the second argument is omitted, the repo will be cloned to the current directory.
tiged user/repo my-new-projectNormally tiged caches tar.gz of the repo for future use. This is sometimes unwanted (e.g. scroll down for known bug)
tiged --disable-cache user/repoTo clone a specific subdirectory instead of the entire repo, just add it to the argument:
tiged user/repo/subdirectoryTo get a GitLab repo that has a subgroup use the --subgroup option.
tiged --subgroup https://gitlab.com/group-test-repo/subgroup-test-repo/test-repo my-dir
tiged -s https://gitlab.com/group-test-repo/subgroup-test-repo/test-repo my-dirTo get a subdirectory of a repo inside a subgroup, use the --sub-directory option.
tiged --subgroup https://gitlab.com/group-test-repo/subgroup-test-repo/test-repo --sub-directory subdir1 my-dirIf you have an https_proxy environment variable, Tiged will use it.
Private repos can be cloned by specifying --mode=git (the default is tar). In this mode, Tiged will use git under the hood. It's much slower than fetching a tarball, which is why it's not the default.
Note: this clones over SSH, not HTTPS.
tiged --helpA few salient differences:
- If you
git clone, you get a.gitfolder that pertains to the project template, rather than your project. You can easily forget to re-init the repository, and end up confusing yourself - Caching and offline support (if you already have a
.tar.gzfile for a specific commit, you don't need to fetch it again). - Less to type (
tiged user/repoinstead ofgit clone --depth 1 git@github.com:user/repo) - Composability via actions
- Future capabilities — interactive mode, friendly onboarding and postinstall scripts
You can also use tiged inside a Node script:
const tiged = require('tiged');
const emitter = tiged('user/repo', {
disableCache: true,
force: true,
verbose: true,
});
emitter.on('info', info => {
console.log(info.message);
});
emitter.clone('path/to/dest').then(() => {
console.log('done');
});You can manipulate repositories after they have been cloned with actions, specified in a degit.json file that lives at the top level of the working directory. Currently, there are two actions — clone and remove. Additional actions may be added in future.
// degit.json
[
{
"action": "clone",
"src": "user/another-repo"
}
]This will clone user/another-repo, preserving the contents of the existing working directory. This allows you to, say, add a new README.md or starter file to a repo that you do not control. The cloned repo can contain its own degit.json actions.
// degit.json
[
{
"action": "remove",
"files": ["LICENSE"]
}
]Remove a file at the specified path.
zlib: unexpected end of file: this is solved by using option--disable-cacheor clearing the cache folder (rm -rf ~/.degit); more details in #45
degitwas last released over a year ago Feb 5, 2020, and Rich is not answering pull requests or issues there. He is probably very busy with Svelte and we love him for that.Rich has now (April 1, 2021) merged the main branch fix. Regardless currently this fork is still more fully featured and will continue to be developed.- We want pull requests merged. E.g. like automatically working with
mainor other default branch (has been merged!). - Update dependencies.
- Hopefully get multiple active maintainers.
- Works with
mainor any default branch automatically. #243 --mode=gitwith private repos now work on Windows #191.degit --helpnow works. Previously it would crash instead of displaying help.md contents. #179--mode=gitis now faster. #171- Github Actions CI tests working. Added Github Actions badge and removed old CI badges.
- Added support for privately hosted git repositories (#10)
- GitLab works again. #18
- Subdir works in
--mode=git#19 - Subgroups work in GitLab #24
- Hashes work with git mode #34
- Using full async + cjs (no build needed) #41
- Option to not use cache #36
- zel by Vu Tran
- gittar by Luke Edwards
- gitpick - by Neeraj Dalal
MIT.