lfspull

Crates.iolfspull
lib.rslfspull
version0.3.1
sourcesrc
created_at2022-10-21 06:28:27.888404
updated_at2024-09-06 11:35:42.48966
descriptionA simple git lfs file pulling implementation in pure rust. Can only pull files / folders and only support token-auth for now.
homepagehttps://github.com/VolumeGraphics/lfspull
repositoryhttps://github.com/VolumeGraphics/lfspull
max_upload_size
id693218
size100,594
rust crate owners (github:volumegraphics:rust-crate-owners)

documentation

https://docs.rs/lfspull

README

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'
Commit count: 28

cargo fmt