This page is intentionally minimal. It gets a new user from zero to a working git-drs repository with as little explanation as possible.
If you want the workflow explained after setup, continue to Getting Started.
Set the release you want to install before running the commands below:
export GIT_DRS_VERSION=v0.7.11=== "macOS (Apple Silicon)"
```bash
curl -L -o "git-drs-darwin-arm64-${GIT_DRS_VERSION}.tar.gz" \
"https://github.com/calypr/git-drs/releases/download/${GIT_DRS_VERSION}/git-drs-darwin-arm64-${GIT_DRS_VERSION}.tar.gz"
tar -xzf "git-drs-darwin-arm64-${GIT_DRS_VERSION}.tar.gz"
install -m 0755 git-drs "$HOME/.local/bin/git-drs"
```
=== "macOS (Intel)"
```bash
curl -L -o "git-drs-darwin-amd64-${GIT_DRS_VERSION}.tar.gz" \
"https://github.com/calypr/git-drs/releases/download/${GIT_DRS_VERSION}/git-drs-darwin-amd64-${GIT_DRS_VERSION}.tar.gz"
tar -xzf "git-drs-darwin-amd64-${GIT_DRS_VERSION}.tar.gz"
install -m 0755 git-drs "$HOME/.local/bin/git-drs"
```
=== "Linux (x86_64)"
```bash
curl -L -o "git-drs-linux-amd64-${GIT_DRS_VERSION}.tar.gz" \
"https://github.com/calypr/git-drs/releases/download/${GIT_DRS_VERSION}/git-drs-linux-amd64-${GIT_DRS_VERSION}.tar.gz"
tar -xzf "git-drs-linux-amd64-${GIT_DRS_VERSION}.tar.gz"
install -m 0755 git-drs "$HOME/.local/bin/git-drs"
```
=== "Linux (arm64)"
```bash
curl -L -o "git-drs-linux-arm64-${GIT_DRS_VERSION}.tar.gz" \
"https://github.com/calypr/git-drs/releases/download/${GIT_DRS_VERSION}/git-drs-linux-arm64-${GIT_DRS_VERSION}.tar.gz"
tar -xzf "git-drs-linux-arm64-${GIT_DRS_VERSION}.tar.gz"
install -m 0755 git-drs "$HOME/.local/bin/git-drs"
```
=== "Windows"
There is no packaged Windows release in this flow. Build `git-drs` from source instead.
Verify:
git-drs versionSee the non-secret server defaults included with your installed release:
git drs preset list
git drs preset show calyprThe built-in aliases are calypr, terra, synapse, and cgc. Only
Calypr/Gen3 and Terra currently have operational runtime adapters; Synapse and
CGC are catalog-only presets. Presets supply
the endpoint, provider adapter, and usual authentication method; they never
contain credentials.
For the Calypr/Gen3 workflow below, download your Gen3 API credentials JSON from your commons profile page and save it somewhere stable, for example:
~/.gen3/credentials.jsonTypical flow:
- Sign in to the Gen3 portal.
- Open your profile page.
- Click
Create API Key. - Download the JSON file.
- Save it somewhere stable.
On the command line, refer to the file as file:~/.gen3/credentials.json.
Other supported credential sources are env:VARIABLE, helper:NAME,
profile:NAME, and stdin. Do not put a token or password directly in
--credential.
git clone <repo-url>
cd <repo-name>
git drs remote add production calypr --scope <organization/project> \
--credential file:~/.gen3/credentials.json
git drs pullUse this path when the repository already contains tracked pointers and you want local file contents.
mkdir my-data-repo
cd my-data-repo
git init
git drs remote add production calypr --scope <organization/project> \
--credential file:~/.gen3/credentials.json
git drs track "*.bam"
git add .gitattributes
git commit -m "Configure tracked files"production is the local remote name and calypr is the preset. If the preset
name is also a suitable local name, the shorter form is
git drs remote add calypr ....
Update Git history:
git pullHydrate tracked pointer files already present in the checkout:
git drs pullRegister/upload tracked objects and complete the managed push flow:
git drs pushUse plain git push only when you intentionally want Git-only ref updates without the managed git-drs upload/registration path.
- Getting Started for the workflow model
- Commands Reference for exact command behavior