git_lfs¶
GitLfs ¶
Bases: Tool[_R]
Classes:
| Name | Description |
|---|---|
Fetch |
|
Install |
|
LsFiles |
|
Pull |
|
Push |
|
Track |
|
Untrack |
|
Methods:
| Name | Description |
|---|---|
__call__ |
git lfs |
flags |
Bind tool-level global options before the subcommand. |
Attributes:
| Name | Type | Description |
|---|---|---|
fetch |
Fetch[_R]
|
|
install |
Install[_R]
|
|
ls_files |
LsFiles[_R]
|
|
pull |
Pull[_R]
|
|
push |
Push[_R]
|
|
track |
Track[_R]
|
|
untrack |
Untrack[_R]
|
|
argv |
GitLfs[Argv]
|
|
Fetch ¶
Bases: Tool[_R2]
Methods:
| Name | Description |
|---|---|
__call__ |
git lfs fetch |
Attributes:
| Name | Type | Description |
|---|---|---|
argv |
Fetch[Argv]
|
|
__call__ ¶
__call__(*args: str | PathLike[str], I: Value = ..., X: Value = ..., a: Flag = ..., all: Flag = ..., d: Flag = ..., dry_run: Flag = ..., exclude: Value = ..., include: Value = ..., j: Flag = ..., json: Flag = ..., p: Flag = ..., prune: Flag = ..., r: Flag = ..., recent: Flag = ..., refetch: Flag = ..., stdin: Flag = ..., **flags: Any) -> _R2
git lfs fetch [options] [<remote> [<ref>...]]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
all
|
Flag
|
Download all objects that are referenced by any commit reachable from the refs provided as arguments. |
...
|
dry_run
|
Flag
|
Print what would be fetched, without actually fetching anything. |
...
|
exclude
|
Value
|
Specify lfs.fetchexclude just for this invocation; see "Include and exclude". |
...
|
include
|
Value
|
Specify lfs.fetchinclude just for this invocation; see "Include and exclude". |
...
|
json
|
Flag
|
Writes the details of all object transfer requests as JSON to STDOUT, if the command exits successfully. |
...
|
prune
|
Flag
|
Prune old and unreferenced objects after fetching, equivalent to running git lfs prune afterwards. |
...
|
recent
|
Flag
|
Download objects referenced by recent branches & commits in addition to those that would otherwise be downloaded. |
...
|
refetch
|
Flag
|
Also fetch objects that are already present locally. |
...
|
stdin
|
Flag
|
Read a list of newline-delimited refs from standard input instead of the command line. |
...
|
Install ¶
Bases: Tool[_R2]
Methods:
| Name | Description |
|---|---|
__call__ |
git lfs install [options] |
Attributes:
| Name | Type | Description |
|---|---|---|
argv |
Install[Argv]
|
|
__call__ ¶
__call__(*args: str | PathLike[str], f: Flag = ..., file: Value = ..., force: Flag = ..., l: Flag = ..., local: Flag = ..., m: Flag = ..., manual: Flag = ..., s: Flag = ..., skip_repo: Flag = ..., skip_smudge: Flag = ..., system: Flag = ..., w: Flag = ..., worktree: Flag = ..., **flags: Any) -> _R2
git lfs install [options]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
file
|
Value
|
Sets the lfs smudge and clean filters in the Git configuration file specified by the |
...
|
force
|
Flag
|
Sets the "lfs" smudge and clean filters, overwriting existing values. |
...
|
local
|
Flag
|
Sets the "lfs" smudge and clean filters in the local repository's git config, instead of the global git config (~/.gitconfig). |
...
|
manual
|
Flag
|
Print instructions for manually updating your hooks to include git-lfs functionality. |
...
|
skip_repo
|
Flag
|
Skips installation of hooks into the local repository; use if you want to install the LFS filters but not make changes to the hooks. |
...
|
skip_smudge
|
Flag
|
Skips automatic downloading of objects on clone or pull. |
...
|
system
|
Flag
|
Sets the "lfs" smudge and clean filters in the system git config, e.g. /etc/gitconfig instead of the global git config (~/.gitconfig). |
...
|
worktree
|
Flag
|
Sets the "lfs" smudge and clean filters in the current working tree's git config, instead of the global git config (~/.gitconfig) or local repository's git config ($GIT_DIR/config). |
...
|
LsFiles ¶
Bases: Tool[_R2]
Methods:
| Name | Description |
|---|---|
__call__ |
git lfs ls-files [] |
Attributes:
| Name | Type | Description |
|---|---|---|
argv |
LsFiles[Argv]
|
|
__call__ ¶
__call__(*args: str | PathLike[str], I: Value = ..., X: Value = ..., a: Flag = ..., all: Flag = ..., d: Flag = ..., debug: Flag = ..., deleted: Flag = ..., exclude: Value = ..., include: Value = ..., j: Flag = ..., json: Flag = ..., l: Flag = ..., long: Flag = ..., n: Flag = ..., name_only: Flag = ..., s: Flag = ..., size: Flag = ..., **flags: Any) -> _R2
git lfs ls-files []
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
all
|
Flag
|
Inspects the full history of the repository, not the current HEAD (or other provided reference). |
...
|
debug
|
Flag
|
Show as much information as possible about a LFS file. |
...
|
deleted
|
Flag
|
Shows the full history of the given reference, including objects that have been deleted. |
...
|
exclude
|
Value
|
Exclude paths matching any of these patterns; see "Fetch settings". |
...
|
include
|
Value
|
Include paths matching only these patterns; see "Fetch settings". |
...
|
json
|
Flag
|
Writes Git LFS file information as JSON to STDOUT, if the command exits successfully. |
...
|
long
|
Flag
|
Show the entire 64 character OID, instead of just first 10. |
...
|
name_only
|
Flag
|
Show only the lfs tracked file names. |
...
|
size
|
Flag
|
Show the size of the LFS object between parenthesis at the end of a line. |
...
|
Pull ¶
Push ¶
Bases: Tool[_R2]
Methods:
| Name | Description |
|---|---|
__call__ |
git lfs push [options] |
Attributes:
| Name | Type | Description |
|---|---|---|
argv |
Push[Argv]
|
|
__call__ ¶
__call__(*args: str | PathLike[str], a: Flag = ..., all: Flag = ..., d: Flag = ..., dry_run: Flag = ..., o: Flag = ..., object_id: Flag = ..., stdin: Flag = ..., **flags: Any) -> _R2
git lfs push [options]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
all
|
Flag
|
This pushes all objects to the remote that are referenced by any commit reachable from the refs provided as arguments. |
...
|
dry_run
|
Flag
|
Print the files that would be pushed, without actually pushing them. |
...
|
object_id
|
Flag
|
This pushes only the object OIDs listed at the end of the command, separated by spaces. |
...
|
stdin
|
Flag
|
Read a list of newline-delimited refs (or object IDs when using --object-id) from standard input instead of the command line. |
...
|
Track ¶
Bases: Tool[_R2]
Methods:
| Name | Description |
|---|---|
__call__ |
git lfs track |
Attributes:
| Name | Type | Description |
|---|---|---|
argv |
Track[Argv]
|
|
__call__ ¶
__call__(*args: str | PathLike[str], d: Flag = ..., dry_run: Flag = ..., filename: Flag = ..., j: Flag = ..., json: Flag = ..., l: Flag = ..., lockable: Flag = ..., no_excluded: Flag = ..., no_modify_attrs: Flag = ..., not_lockable: Flag = ..., v: Flag = ..., verbose: Flag = ..., **flags: Any) -> _R2
git lfs track [options] [<pattern>...]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dry_run
|
Flag
|
If enabled, have git lfs track log all actions it would normally take (adding entries to .gitattributes, touching files on disk, etc) without performing any mutative operations to the disk. |
...
|
filename
|
Flag
|
Treat the arguments as literal filenames, not as patterns. |
...
|
json
|
Flag
|
Writes the currently tracked patterns as JSON to STDOUT, if the command exits successfully. |
...
|
lockable
|
Flag
|
Make the paths 'lockable', meaning they should be locked to edit them, and will be made read-only in the working copy when not locked. |
...
|
no_excluded
|
Flag
|
Do not list patterns that are excluded in the output; only list patterns that are tracked. |
...
|
no_modify_attrs
|
Flag
|
Makes matched entries stat-dirty so that Git can re-index files you wish to convert to LFS. |
...
|
not_lockable
|
Flag
|
Remove the lockable flag from the paths so they are no longer read-only unless locked. |
...
|
verbose
|
Flag
|
If enabled, have git lfs track log files which it will touch. |
...
|