git-drs is not a pure GA4GH DRS client. It targets Syfon/Gen3-style DRS workflows and uses extensions where repo-scale behavior requires them.
Git/DRS orchestration with Git-compatible pointer workflows
git-drs manages:
- remote Gen3/Syfon configuration
- local DRS metadata
- pointer-aware push/pull orchestration
- bucket-scoped object reference workflows
- unified Git/data workflow around DRS-backed pointers
- Gen3/Syfon integration
- multiple remotes in one repository
- explicit file tracking and hydration
- metadata-only reference support for existing bucket objects
At a high level:
- configure a remote for one
organization/project - let
remote addbootstrap repo-localgit-drsstate if needed - track file patterns with
git drs track - add/commit/push normally
- remove tracked pointers with
git drs rmwhen you want repository deletion to reconcile with remote DRS state - hydrate pointer files later with
git drs pull
git drs install
git drs remote add gen3 production HTAN_INT/BForePC --cred /path/to/credentials.json
git drs track "*.bam"
git add .gitattributes
git add sample.bam
git commit -m "Add sample"
git drs push
git drs ls-files
git drs pull -I "*.bam"The cleaned CLI intentionally removed legacy commands:
- removed:
git drs fetchgit drs listgit drs uploadgit drs download
git drs pullis hydration-onlygit drs ls-filesis the local file inventory commandgit drs remote add gen3takes scope asorganization/project
Example:
git drs remote add gen3 production HTAN_INT/BForePC --cred /path/to/credentials.jsonEnd users should not need to know the bucket name.
Push and pull depend on server-side bucket mapping for the requested scope. That mapping is normally provisioned once by a steward/admin using the bucket commands.
| Command | Description |
|---|---|
git drs install |
Install global git-drs filter config |
git drs init |
Explicitly initialize or repair repository-local git-drs state |
git drs remote add gen3 [remote] <org/project> |
Add or refresh a Gen3/Syfon remote |
git drs remote list |
List configured remotes |
git drs remote remove <name> |
Remove a configured DRS remote |
git drs remote set <name> |
Set the default remote |
git drs track <pattern> |
Track files or globs |
git drs untrack <pattern> |
Stop tracking files or globs |
git drs rm <path>... |
Remove tracked DRS/LFS files from Git |
git drs ls-files |
List tracked files and localization state |
git drs pull |
Hydrate pointer files in the current checkout |
git drs push |
Register/upload objects, reconcile committed deletes, and push refs |
git drs add-url |
Add an existing provider object by URL or scoped key |
git drs add-ref |
Add a local reference to an existing DRS object |
git drs query |
Query a DRS object by ID |
git drs copy-records |
Copy Syfon records between remotes for one scope |
- Git
- access credentials for the target Gen3/Syfon deployment
- Go 1.26.2+ for local builds