You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tools/git-drs/docs/index.md
+23-21Lines changed: 23 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,66 +4,68 @@ title: Git-DRS
4
4
5
5
# Git-DRS
6
6
7
-
Git-DRS is a Git extension for managing large files in a Gen3 Data Commons using the **Data Repository Service (DRS)** content-addressable storage model. It essentially serves as a Git-LFS (Large File Storage) replacement tailored for Gen3.
7
+
Git-DRS is a Git extension for managing large files using the **Data Repository Service (DRS)** content-addressable storage model.
8
+
It serves as a Git LFS (Large File Storage) replacement tailored for the GA4GH Data Repository Service specification.
8
9
9
10
It allows you to:
10
-
- Track large files in your git repository without bloating it.
11
+
12
+
- Track large files in your Git repository without bloating it.
11
13
- Store the actual file contents in a Gen3 data commons (indexed via DRS).
12
14
- Seamlessly synchronize files between your local environment and the commons.
13
15
14
16
## Installation
15
17
16
-
Ensure `git-drs` is installed and in your PATH.
18
+
Ensure `git-drs` is installed and available in your `PATH`.
17
19
18
20
## Initialization
19
21
20
-
Initialize a repository to use Git-DRS. This sets up the necessary hooks and configuration.
22
+
Initialize a repository to use Git-DRS. This command sets up the necessary hooks and configuration.
21
23
22
24
```bash
23
-
git-drs init
25
+
gitdrs init
24
26
```
25
27
26
28
## Basic Workflow
27
29
28
30
1.**Add a file**: Track a large file with Git-DRS.
29
31
```bash
30
-
git-drs add <filename>
32
+
gitdrs add <filename>
31
33
```
32
-
This replaces the large file with a small pointer file in your working directory.
34
+
This replaces the large file with a small pointer file in your working tree.
33
35
34
-
2. **Push**: Upload the tracked files to the Gen3 Commons.
36
+
2. **Push**: Upload the tracked files to the DRS server.
35
37
```bash
36
-
git-drs push
38
+
gitdrs push
37
39
```
38
40
39
-
3. **Fetch**: Download file contents (resolving pointer files) from the Commons.
41
+
3. **Fetch**: Download file contents (resolving pointer files) from the DRS server.
40
42
```bash
41
-
git-drs fetch
43
+
gitdrs fetch
42
44
```
43
45
44
46
## Command Reference
45
47
46
48
### `init`
47
-
Initializes`git-drs`in the current git repository. Recommended to run at the root of the repo.
49
+
Initialize`git-drs`in the current Git repository. Run this at the repository root.
48
50
49
51
### `add <file>`
50
-
Tracks a file using Git-DRS. The file content is moved to a local cache, and replaced with a pointer file containing its hash and size.
52
+
Track a file using Git-DRS. The file contents are moved to a local cache and replaced with a pointer file containing its hash and size.
51
53
52
54
### `push`
53
-
Uploads the contents of tracked files to the configured Gen3 Commons. This usually happens automatically during `git push`if hooks are configured, but can be run manually.
55
+
Upload tracked file contents to the configured DRS server. This usually happens automatically during `git push`if hooks are configured, but you can run it manually.
54
56
55
57
### `fetch`
56
-
Downloads the contents of tracked files from the Gen3 Commons, replacing thelocal pointer files with the actual data.
58
+
Download tracked file contents from the DRS server, replacing local pointer files with the actual data.
57
59
58
60
### `list`
59
-
Lists the files currently tracked by Git-DRS in the project.
61
+
List files currently tracked by Git-DRS in the project.
0 commit comments