gitcp 0.2.0

Copy files from Git repository to local.
Documentation 
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

# gitcp

Copy files from Git repository to local.

## Usage

```
$ gitcp --help
gitcp 0.1.0
Copy files from Git repository to local.

USAGE:
    gitcp <source> [destination]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

ARGS:
    <source>         GitHub repository name (e.g. r7kamura/gitcp)
    <destination>    Path to destination directory [default: .]
```

### Copy all files

Copy all files from https://github.com/owner/repo to current directory.

```
gitcp owner/repo
```

### Copy all files into specific directory

```
gitcp owner/repo tmp/repo
```

### Copy all files from specific ref

```
gitcp owner/repo@v1
```

### Copy specific file

```
gitcp owner/repo/foo.txt
```

### Copy specific files

You can specify [globwalk](https://github.com/Gilnaa/globwalk) powered glob patterns.

```
gitcp owner/repo/{foo,bar}.*
```

## Configuration

### .gitcpignore

If there is `.gitcpignore` in the copied repository side, it will be used to ignore files.

```
# .gitcpignore
CHANGELOG.md
README.md
```

## Background

As a tool creator, this can be useful when you want to provide users with some initial template files.

For example, when providing a custom GitHub Action, it's more convenient to explain like this:

> Please run the following command:
>
> ```
> gitcp owner/my-custom-action-template
> ```

than to explain like this:

> Please create a workflow with the following content:
>
> ```yaml
> # .github/workflows/my-custom-action.yml
> ...
> ```
>
> and then put config file like this:
>
> ```yaml
> # my-custom-action-settings.yml
> ...
> ```

I had exactly that experience when I created [github-label-sync-action](https://github.com/r7kamura/github-label-sync-action), so I thought it would be nice to have such a tool, and that's I came to create this.