git-locked

List all local locked files

$ git locked

git lfs lock <path>... [<options>]

<path>...
    Specifies one or more paths to files that should be locked. These files must be tracked by Git LFS.

--json
    Outputs the lock details in JSON format, which can be useful for scripting or programmatic consumption.

The command git-locked is not a standard Git or Linux command. This analysis refers to git lfs lock, a subcommand of Git Large File Storage (LFS).

git lfs lock allows developers to acquire an exclusive lock on files tracked by Git LFS. This is particularly crucial for binary files (like images, audio, or large datasets) where traditional Git merging is ineffective or impossible. By locking a file, a developer signals that they are actively working on it, preventing others from pushing changes to the same file and thus avoiding potential conflicts.

The locking mechanism is server-side and advisory; it requires a Git LFS server that supports locking. When a file is locked, only the locker can push changes to that file. Other collaborators attempting to push changes to a locked file will be prevented from doing so. The lock must be explicitly released using git lfs unlock once editing is complete.

The command 'git-locked' itself does not exist as a standalone Git or Linux command. This analysis is based on git lfs lock, a subcommand of Git LFS.

File locking with Git LFS requires both Git LFS to be installed and configured in your repository, and the remote Git LFS server must support the locking API.

Locks are advisory, meaning they prevent pushes to the locked file on the server, but do not prevent local modifications or merges on a user's machine. Users must still respect the locking convention.

A typical locking workflow involves: 1. A user locks a file using git lfs lock <file>. 2. They make their modifications and commit them locally. 3. They push their changes, which also synchronizes the lock status with the LFS server. 4. Once done, the user unlocks the file using git lfs unlock <file> to allow others to acquire the lock and make changes.

It's important to understand that Git LFS locks are advisory. They prevent other users from pushing changes to a locked file on the remote server, but they do not prevent local modifications or the creation of conflicting local branches. Adherence to the locking protocol relies on team cooperation.

The Git LFS project was initiated by GitHub to handle large files efficiently within Git repositories. The file locking feature was introduced with Git LFS 2.0 in 2017. This addition significantly improved collaborative workflows for projects dealing with binary assets, by addressing the long-standing challenge of managing conflicts in non-mergeable files.

git-lfs(1), git-lfs-unlock(1), git-lfs-ls-locks(1), git(1)