class Git::Commands::Add

Implements the ‘git add` command

This command updates the index using the current content found in the working tree, to prepare the content staged for the next commit.

@example Basic usage

add = Git::Commands::Add.new(execution_context)
add.call('path/to/file')
add.call('file1.rb', 'file2.rb')
add.call(all: true)

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

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

@see Git::Commands

@api private

Public Instance Methods

call (*, **)

Source

# File lib/git/commands/add.rb, line 134
def call(*, **)
  super
end

@overload call(*pathspec, **options)

Execute the `git add` command

@param pathspec [Array<String>] files to be added to the repository
  (relative to the worktree root)

@param options [Hash] command options

@option options [Boolean, nil] :verbose (nil) be verbose

  Alias: :v

@option options [Boolean, nil] :dry_run (nil) don't actually add files;
  show what would be added

  Alias: :n

@option options [Boolean, nil] :force (nil) allow adding otherwise ignored
  files

  Alias: :f

@option options [Boolean, nil] :all (nil) add, modify, and remove index
  entries to match the worktree (--all)

  Alias: :A

@option options [Boolean, nil] :no_all (nil) add and modify index entries
  without staging removals (--no-all)

@option options [Boolean, nil] :ignore_removal (nil) add and modify files;
  ignore removals (--ignore-removal)

@option options [Boolean, nil] :no_ignore_removal (nil) include file removals
  (--no-ignore-removal)

@option options [Boolean, nil] :update (nil) update tracked files only; does
  not add new files

  Alias: :u

@option options [Boolean, nil] :sparse (nil) allow updating index entries
  outside the sparse-checkout cone

@option options [Boolean, nil] :intent_to_add (nil) record that the path
  will be added later, placing an empty entry in the index

  Alias: :N

@option options [Boolean, nil] :refresh (nil) refresh stat() information in
  the index without adding files

@option options [Boolean, nil] :ignore_errors (nil) continue adding other
  files if some files cannot be added due to indexing errors

@option options [Boolean, nil] :ignore_missing (nil) check whether any given
  files would be ignored

@option options [Boolean, nil] :renormalize (nil) apply the "clean" process
  freshly to all tracked files to forcibly re-add them with correct line
  endings

@option options [Boolean, nil] :no_warn_embedded_repo (nil) suppress warning
  when adding an embedded repository without using `git submodule add`

@option options [String] :chmod (nil) override the executable bit of added
  files in the index

  Value must be `'+x'` or `'-x'`

@option options [String] :pathspec_from_file (nil) read pathspec from the
  given file (use `'-'` for stdin)

@option options [Boolean, nil] :pathspec_file_nul (nil) separate pathspec
  elements with NUL when reading from a file

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

@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