Skip to content

quickstart.md

Latest commit

 

History

History
121 lines (85 loc) · 2.86 KB

quickstart.md

File metadata and controls

121 lines (85 loc) · 2.86 KB

Quick Start

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.

1. Install git-drs

This quick start uses release v0.6.0.

=== "macOS (Apple Silicon)"

```bash
curl -L -o git-drs-darwin-arm64-v0.6.0.tar.gz \
  https://github.com/calypr/git-drs/releases/download/v0.6.0/git-drs-darwin-arm64-v0.6.0.tar.gz
tar -xzf git-drs-darwin-arm64-v0.6.0.tar.gz
install -m 0755 git-drs "$HOME/.local/bin/git-drs"
```

=== "macOS (Intel)"

```bash
curl -L -o git-drs-darwin-amd64-v0.6.0.tar.gz \
  https://github.com/calypr/git-drs/releases/download/v0.6.0/git-drs-darwin-amd64-v0.6.0.tar.gz
tar -xzf git-drs-darwin-amd64-v0.6.0.tar.gz
install -m 0755 git-drs "$HOME/.local/bin/git-drs"
```

=== "Linux (x86_64)"

```bash
curl -L -o git-drs-linux-amd64-v0.6.0.tar.gz \
  https://github.com/calypr/git-drs/releases/download/v0.6.0/git-drs-linux-amd64-v0.6.0.tar.gz
tar -xzf git-drs-linux-amd64-v0.6.0.tar.gz
install -m 0755 git-drs "$HOME/.local/bin/git-drs"
```

=== "Linux (arm64)"

```bash
curl -L -o git-drs-linux-arm64-v0.6.0.tar.gz \
  https://github.com/calypr/git-drs/releases/download/v0.6.0/git-drs-linux-arm64-v0.6.0.tar.gz
tar -xzf git-drs-linux-arm64-v0.6.0.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 version

2. Get Credentials

Download your Gen3 API credentials JSON from your commons profile page and save it somewhere stable, for example:

~/.gen3/credentials.json

Typical flow:

  1. Sign in to the Gen3 portal.
  2. Open your profile page.
  3. Click Create API Key.
  4. Download the JSON file.
  5. Save it somewhere stable.

3. Connect An Existing Repository

git clone <repo-url>
cd <repo-name>
git drs remote add gen3 production <organization/project> --cred ~/.gen3/credentials.json
git drs pull

Use this path when the repository already contains tracked pointers and you want local file contents.

4. Start A New Repository

mkdir my-data-repo
cd my-data-repo
git init
git drs remote add gen3 production <organization/project> --cred ~/.gen3/credentials.json
git drs track "*.bam"
git add .gitattributes
git commit -m "Configure tracked files"

5. Day-One Commands

Pull Git history:

git pull

Hydrate tracked files:

git drs pull

Upload/register tracked objects:

git drs push

Read Next