| 1 | # _degit_
|
| 2 |
|
| 3 | Usage:
|
| 4 |
|
| 5 | `degit <src>[#ref] [<dest>] [options]`
|
| 6 |
|
| 7 | Fetches the `src` repo, and extracts it to `dest` (or the current directory).
|
| 8 |
|
| 9 | The `src` argument can be any of the following:
|
| 10 |
|
| 11 | ## GitHub repos
|
| 12 |
|
| 13 | user/repo
|
| 14 | github:user/repo
|
| 15 | https://github.com/user/repo
|
| 16 |
|
| 17 | ## GitLab repos
|
| 18 |
|
| 19 | gitlab:user/repo
|
| 20 | https://gitlab.com/user/repo
|
| 21 |
|
| 22 | ## BitBucket repos
|
| 23 |
|
| 24 | bitbucket:user/repo
|
| 25 | https://bitbucket.com/user/repo
|
| 26 |
|
| 27 | ## Sourcehut repos
|
| 28 |
|
| 29 | git.sr.ht/user/repo
|
| 30 | git@git.sr.ht:user/repo
|
| 31 | https://git.sr.ht/user/repo
|
| 32 |
|
| 33 | You can append a #ref to any of the above:
|
| 34 |
|
| 35 | ## Branches (defaults to master)
|
| 36 |
|
| 37 | user/repo#dev
|
| 38 |
|
| 39 | ## Tags
|
| 40 |
|
| 41 | user/repo#v1.2.3
|
| 42 |
|
| 43 | ## Commit hashes
|
| 44 |
|
| 45 | user/repo#abcd1234
|
| 46 |
|
| 47 | The `dest` directory (or the current directory, if unspecified) must be empty
|
| 48 | unless the `--force` option is used.
|
| 49 |
|
| 50 | Options:
|
| 51 |
|
| 52 | `--help`, `-h` Show this message
|
| 53 | `--cache`, `-c` Only use local cache
|
| 54 | `--force`, `-f` Allow non-empty destination directory
|
| 55 | `--verbose`, `-v` Extra logging
|
| 56 | `--mode=`, `-m=` Force the mode by which degit clones the repo
|
| 57 | Valid options are `tar` or `git` (uses SSH)
|
| 58 |
|
| 59 | See https://github.com/Rich-Harris/degit for more information
|