giget 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -14
- package/dist/cli.cjs +1 -1
- package/dist/cli.mjs +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
|
|
12
12
|
✔ Support popular git providers (GitHub, GitLab, and Bitbucket) out of the box.
|
|
13
13
|
|
|
14
|
-
✔ Built-in and custom template registry.
|
|
14
|
+
✔ Built-in and custom [template registry](#template-registry).
|
|
15
15
|
|
|
16
16
|
✔ Fast cloning using tarball gzip without depending on local `git` and `tar`.
|
|
17
17
|
|
|
@@ -24,22 +24,15 @@
|
|
|
24
24
|
## Usage (CLI)
|
|
25
25
|
|
|
26
26
|
```bash
|
|
27
|
-
npx giget@latest <
|
|
27
|
+
npx giget@latest <template> [<dir>] [...options]
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
|
|
31
|
-
npx giget@latest gh:unjs/template my-lib
|
|
32
|
-
# ✨ Successfully cloned https://github.com/unjs/template/tree/main/ to my-lib
|
|
33
|
-
```
|
|
30
|
+
### Arguments
|
|
34
31
|
|
|
35
|
-
**
|
|
32
|
+
- **template**: Template name or a a URI describing provider, repository, subdir, and branch/ref. (See [Examples](#examples))
|
|
33
|
+
- **dir**: A relative or absolute path where to extract the template.
|
|
36
34
|
|
|
37
|
-
|
|
38
|
-
- Format is `[provider]:repo[/subpath][#ref]`.
|
|
39
|
-
- **dir**: A relative or absolute path where to extract the repository.
|
|
40
|
-
- If not provided, the name of the org + repo will be used as the name.
|
|
41
|
-
|
|
42
|
-
**Options:**
|
|
35
|
+
### Options
|
|
43
36
|
|
|
44
37
|
- `--force`: Clone to exsiting directory even if exists.
|
|
45
38
|
- `--offline`: Do not attempt to download and use cached version.
|
|
@@ -50,7 +43,7 @@ npx giget@latest gh:unjs/template my-lib
|
|
|
50
43
|
- `--no-registry`: Disable registry lookup and functionality.
|
|
51
44
|
- `--verbose`: Show verbose debugging info.
|
|
52
45
|
|
|
53
|
-
|
|
46
|
+
### Examples
|
|
54
47
|
|
|
55
48
|
```sh
|
|
56
49
|
# Clone the main branch of github.com/unjs/template to unjs-template directory
|
package/dist/cli.cjs
CHANGED
|
@@ -38,7 +38,7 @@ async function main() {
|
|
|
38
38
|
offline: args.offline,
|
|
39
39
|
registry: args.registry
|
|
40
40
|
});
|
|
41
|
-
console.log(`\u2728 Successfully cloned ${colorette.cyan(r.url)} to ${colorette.cyan(node_path.relative(process.cwd(), r.dir))}
|
|
41
|
+
console.log(`\u2728 Successfully cloned ${colorette.cyan(r.name || r.url)} to ${colorette.cyan(node_path.relative(process.cwd(), r.dir))}
|
|
42
42
|
`);
|
|
43
43
|
if (args.shell) {
|
|
44
44
|
giget.startShell(r.dir);
|
package/dist/cli.mjs
CHANGED
|
@@ -32,7 +32,7 @@ async function main() {
|
|
|
32
32
|
offline: args.offline,
|
|
33
33
|
registry: args.registry
|
|
34
34
|
});
|
|
35
|
-
console.log(`\u2728 Successfully cloned ${cyan(r.url)} to ${cyan(relative(process.cwd(), r.dir))}
|
|
35
|
+
console.log(`\u2728 Successfully cloned ${cyan(r.name || r.url)} to ${cyan(relative(process.cwd(), r.dir))}
|
|
36
36
|
`);
|
|
37
37
|
if (args.shell) {
|
|
38
38
|
startShell(r.dir);
|