Skip to content

Simple command line tool to pull lfs files with token auth

License

Notifications You must be signed in to change notification settings

VolumeGraphics/lfspull

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LFSPull - a simple pulling tool for git-lfs

Crates.io Documentation CI Coverage Status License

Features

LFSPull allows you to pull files from git-lfs. It currently supports:

  • Token-auth only
  • Pulling single files
  • Globbing patterns and pulling all matches
  • Cache-compatible with the original git-lfs
  • Hash verification of the downloaded file

CLI guide

The CLI is pretty straight forward.

  • -f / --file-to-pull [FILE] single file download mode
    • e.g. lfspull -f my_file.tar.gz downloads the file
  • '-r / --recurse-pattern [PATTERN]' downloads everything that matches the pattern
    • e.g. 'lfspull -r "*.tgz"' downloads all .tgz files in this folder
    • e.g. 'lfspull -r "**/*.tgz"' downloads all .tgz files this folder and all subfolders
  • '-b / --random-bytes [RANDOM_BYTES]' for temp file name. See https://docs.rs/tempfile/latest/tempfile/struct.Builder.html#method.rand_bytes
  • '-a / --access-token [TOKEN]' sets the token - can also be set via $ACCESS_TOKEN from env
  • '-v' for verbose mode

Library API guide

Please see our docs.rs for example code and the gherkin tests for how to check the origin of the file.

Changelog

0.3.1

  • fix bug when trying to rename temp file to cache file, but cache file is already created and locked by other parallel job

0.3.0

  • use stream_bytes to download object directly into a temporary files and avoid 'memory allocation of x bytes failed'