Skip to main content
← All guides

Connect your first repository

Keep Git where it is. Point Git LFS at your LFSPush repository and verify a clean clone.

Create your workspace

  1. Sign in with GitHub and create an organization. GitHub provides your identity; LFSPush membership controls file access independently.
  2. Register a repository in LFSPush. Its optional GitHub URL is descriptive and does not grant access to GitHub.
  3. Create a write token scoped to that repository. Copy it once and save it in your operating system's credential manager. Give each person their own token; use a service token for automation.

Install and configure Git LFS

Install the standard Git LFS client and configure your operating system's secure Git credential helper. Run these commands inside the Git repository. Replace rep_YOUR_ID with the endpoint copied from the LFSPush repository page.

git lfs version
git lfs install --local
git config --local credential.https://lfspush.dev.useHttpPath true
git config -f .lfsconfig lfs.url https://lfspush.dev/lfs/rep_YOUR_ID
git add .lfsconfig
git commit -m 'Use LFSPush for Git LFS'

Track and push an asset

Choose a file pattern appropriate for your project. Tracking applies to future additions; it does not convert existing Git history. Keep your normal Git remote for commits.

git lfs track '*.bin'
git add .gitattributes path/to/asset.bin
git commit -m 'Track large assets with Git LFS'
git push origin HEAD

Prove a fresh checkout

Use a new directory with its own LFS storage, not a copy of your working directory. Install Git LFS locally, configure the same credential isolation, then download and check out the files. Compare a known file's size and SHA-256 hash with your source. Check at least one older revision when migrating history.

GIT_LFS_SKIP_SMUDGE=1 git clone YOUR_GIT_REMOTE fresh-check
cd fresh-check
git lfs install --local
git config --local credential.https://lfspush.dev.useHttpPath true
git lfs pull
git lfs ls-files
Open your workspace