class Git::Commands::Checkout::Files

Implements the ‘git checkout` command for restoring working tree files

This command replaces files in the working tree with versions from the index (when tree_ish is nil) or a specified tree-ish (commit, branch, tag, etc.).

@example Restore working tree files

files = Git::Commands::Checkout::Files.new(execution_context)
files.call(pathspec: ['lib/foo.rb'])                             # from the index
files.call('HEAD~1', pathspec: ['lib/foo.rb'])                   # from a specific commit
files.call('main', pathspec: %w[lib/foo.rb lib/bar.rb])          # from a branch
files.call(pathspec: ['conflicted.txt'], ours: true)             # resolve conflict (ours)
files.call('main', pathspec_from_file: 'paths.txt')              # paths from a file

@note ‘arguments` block audited against git-scm.com/docs/git-checkout/2.53.0

@see Git::Commands::Checkout

@see git-scm.com/docs/git-checkout git-checkout

@api private

Public Instance Methods

call (*, **)

Source

# File lib/git/commands/checkout/files.rb, line 110
def call(*, **)
  super
end

@overload call(tree_ish = nil, **options)

  Execute the git checkout command for restoring files

  @param tree_ish [String, nil] The commit, branch, or tree to restore
    files from

    When `nil`, files are restored from the index

  @param options [Hash] command options

  @option options [Boolean, nil] :force (nil) ignore unmerged entries

    Alias: `:f`

  @option options [Boolean, nil] :ours (nil) for unmerged paths, check out
    stage #2 (our version)

  @option options [Boolean, nil] :theirs (nil) for unmerged paths, check out
    stage #3 (their version)

  @option options [Boolean, nil] :merge (nil) recreate the conflicted merge in
    the specified paths; cannot be used when checking out from a tree-ish

    Alias: `:m`

  @option options [String] :conflict (nil) conflict marker style; valid
    values are `'merge'`, `'diff3'`, and `'zdiff3'`

  @option options [Boolean, nil] :overlay (nil) never remove files from the
    index or working tree that are not present in the tree-ish (`--overlay`)

  @option options [Boolean, nil] :no_overlay (nil) remove files not present
    in the tree-ish from the index and working tree (`--no-overlay`)

  @option options [Boolean, nil] :ignore_skip_worktree_bits (nil) in sparse
    checkout mode, ignore sparse patterns and update all files matched by
    pathspec

  @option options [String] :pathspec_from_file (nil) read pathspec from
    this file; pass `'-'` to read from stdin

  @option options [Boolean, nil] :pathspec_file_nul (nil) with
    `:pathspec_from_file`, separate pathspec elements with NUL instead of
    newline

  @option options [Array<String>, String] :pathspec (nil) the files or
    directories to restore

  @option options [String] :chdir (nil) change to this directory before
    running git; not passed to the git CLI

  @return [Git::CommandLine::Result] the result of calling `git checkout`

  @raise [ArgumentError] if unsupported options are provided

  @raise [Git::FailedError] if git exits with a non-zero exit status

@api public

Calls superclass method Git::Commands::Base::call