6 git-add - Add file contents to the index
11 'git add' [-n] [-v] [--force | -f] [--interactive | -i] [--patch | -p]
12 [--edit | -e] [--all | [--update | -u]] [--intent-to-add | -N]
13 [--refresh] [--ignore-errors] [--ignore-missing] [--]
18 This command updates the index using the current content found in
19 the working tree, to prepare the content staged for the next commit.
20 It typically adds the current content of existing paths as a whole,
21 but with some options it can also be used to add content with
22 only part of the changes made to the working tree files applied, or
23 remove paths that do not exist in the working tree anymore.
25 The "index" holds a snapshot of the content of the working tree, and it
26 is this snapshot that is taken as the contents of the next commit. Thus
27 after making any changes to the working directory, and before running
28 the commit command, you must use the `add` command to add any new or
29 modified files to the index.
31 This command can be performed multiple times before a commit. It only
32 adds the content of the specified file(s) at the time the add command is
33 run; if you want subsequent changes included in the next commit, then
34 you must run `git add` again to add the new content to the index.
36 The `git status` command can be used to obtain a summary of which
37 files have changes that are staged for the next commit.
39 The `git add` command will not add ignored files by default. If any
40 ignored files were explicitly specified on the command line, `git add`
41 will fail with a list of ignored files. Ignored files reached by
42 directory recursion or filename globbing performed by Git (quote your
43 globs before the shell) will be silently ignored. The 'git add' command can
44 be used to add ignored files with the `-f` (force) option.
46 Please see linkgit:git-commit[1] for alternative ways to add content to a
53 Files to add content from. Fileglobs (e.g. `*.c`) can
54 be given to add all matching files. Also a
55 leading directory name (e.g. `dir` to add `dir/file1`
56 and `dir/file2`) can be given to add all files in the
57 directory, recursively.
61 Don't actually add the file(s), just show if they exist and/or will
70 Allow adding otherwise ignored files.
74 Add modified contents in the working tree interactively to
75 the index. Optional path arguments may be supplied to limit
76 operation to a subset of the working tree. See ``Interactive
81 Interactively choose hunks of patch between the index and the
82 work tree and add them to the index. This gives the user a chance
83 to review the difference before adding modified contents to the
86 This effectively runs `add --interactive`, but bypasses the
87 initial command menu and directly jumps to the `patch` subcommand.
88 See ``Interactive mode'' for details.
91 Open the diff vs. the index in an editor and let the user
92 edit it. After the editor was closed, adjust the hunk headers
93 and apply the patch to the index.
95 The intent of this option is to pick and choose lines of the patch to
96 apply, or even to modify the contents of lines to be staged. There are
97 three line types in a patch: addition lines (beginning with a plus),
98 removal lines (beginning with a minus), and context lines (beginning
99 with a space). In general, it should be safe to:
102 * remove addition lines (don't stage the line)
103 * modify the content of any addition lines (stage modified contents)
104 * add new addition lines (stage the new line)
105 * convert context lines to removal lines (stage removal of line)
106 * convert removal lines to context lines (don't stage removal)
109 Similarly, your patch will likely not apply if you:
112 * add context or removal lines
113 * delete removal or context lines
114 * modify the contents of context or removal lines
117 NOTE: In the first list above, the results given for each action are
118 with respect to that patch line only. Conceptual changes like
119 modification of a line in the original file are actually represented by
120 removal of the old line followed by addition of the new line. Deleting
121 only the addition line of this pair but leaving the removal line would
122 therefore convert the modification into a deletion. In other words, use
123 this feature with caution, as it is easy to stage unintended changes.
127 Only match <filepattern> against already tracked files in
128 the index rather than the working tree. That means that it
129 will never stage new files, but that it will stage modified
130 new contents of tracked files and that it will remove files
131 from the index if the corresponding files in the working tree
134 If no <filepattern> is given, default to "."; in other words,
135 update all tracked files in the current directory and its
140 Like `-u`, but match <filepattern> against files in the
141 working tree in addition to the index. That means that it
142 will find new files as well as staging modified content and
143 removing files that are no longer in the working tree.
147 Record only the fact that the path will be added later. An entry
148 for the path is placed in the index with no content. This is
149 useful for, among other things, showing the unstaged content of
150 such files with `git diff` and committing them with `git commit
154 Don't add the file(s), but only refresh their stat()
155 information in the index.
158 If some files could not be added because of errors indexing
159 them, do not abort the operation, but continue adding the
160 others. The command shall still exit with non-zero status.
163 This option can only be used together with --dry-run. By using
164 this option the user can check if any of the given files would
165 be ignored, no matter if they are already present in the work
169 This option can be used to separate command-line options from
170 the list of files, (useful when filenames might be mistaken
171 for command-line options).
177 The optional configuration variable `core.excludesfile` indicates a path to a
178 file containing patterns of file names to exclude from git-add, similar to
179 $GIT_DIR/info/exclude. Patterns in the exclude file are used in addition to
180 those in info/exclude. See linkgit:gitrepository-layout[5].
186 * Adds content from all `*.txt` files under `Documentation` directory
187 and its subdirectories:
190 $ git add Documentation/\*.txt
193 Note that the asterisk `*` is quoted from the shell in this
194 example; this lets the command include the files from
195 subdirectories of `Documentation/` directory.
197 * Considers adding content from all git-*.sh scripts:
203 Because this example lets the shell expand the asterisk (i.e. you are
204 listing the files explicitly), it does not consider
209 When the command enters the interactive mode, it shows the
210 output of the 'status' subcommand, and then goes into its
211 interactive command loop.
213 The command loop shows the list of subcommands available, and
214 gives a prompt "What now> ". In general, when the prompt ends
215 with a single '>', you can pick only one of the choices given
216 and type return, like this:
220 1: status 2: update 3: revert 4: add untracked
221 5: patch 6: diff 7: quit 8: help
225 You also could say `s` or `sta` or `status` above as long as the
228 The main command loop has 6 subcommands (plus help and quit).
232 This shows the change between HEAD and index (i.e. what will be
233 committed if you say `git commit`), and between index and
234 working tree files (i.e. what you could stage further before
235 `git commit` using `git add`) for each path. A sample output
240 1: binary nothing foo.png
241 2: +403/-35 +1/-1 git-add--interactive.perl
244 It shows that foo.png has differences from HEAD (but that is
245 binary so line count cannot be shown) and there is no
246 difference between indexed copy and the working tree
247 version (if the working tree version were also different,
248 'binary' would have been shown in place of 'nothing'). The
249 other file, git-add{litdd}interactive.perl, has 403 lines added
250 and 35 lines deleted if you commit what is in the index, but
251 working tree file has further modifications (one addition and
256 This shows the status information and issues an "Update>>"
257 prompt. When the prompt ends with double '>>', you can
258 make more than one selection, concatenated with whitespace or
259 comma. Also you can say ranges. E.g. "2-5 7,9" to choose
260 2,3,4,5,7,9 from the list. If the second number in a range is
261 omitted, all remaining patches are taken. E.g. "7-" to choose
262 7,8,9 from the list. You can say '*' to choose everything.
264 What you chose are then highlighted with '*',
269 1: binary nothing foo.png
270 * 2: +403/-35 +1/-1 git-add--interactive.perl
273 To remove selection, prefix the input with `-`
280 After making the selection, answer with an empty line to stage the
281 contents of working tree files for selected paths in the index.
285 This has a very similar UI to 'update', and the staged
286 information for selected paths are reverted to that of the
287 HEAD version. Reverting new paths makes them untracked.
291 This has a very similar UI to 'update' and
292 'revert', and lets you add untracked paths to the index.
296 This lets you choose one path out of a 'status' like selection.
297 After choosing the path, it presents the diff between the index
298 and the working tree file and asks you if you want to stage
299 the change of each hunk. You can say:
302 n - do not stage this hunk
303 q - quit; do not stage this hunk nor any of the remaining ones
304 a - stage this hunk and all later hunks in the file
305 d - do not stage this hunk nor any of the later hunks in the file
306 g - select a hunk to go to
307 / - search for a hunk matching the given regex
308 j - leave this hunk undecided, see next undecided hunk
309 J - leave this hunk undecided, see next hunk
310 k - leave this hunk undecided, see previous undecided hunk
311 K - leave this hunk undecided, see previous hunk
312 s - split the current hunk into smaller hunks
313 e - manually edit the current hunk
316 After deciding the fate for all hunks, if there is any hunk
317 that was chosen, the index is updated with the selected hunks.
321 This lets you review what will be committed (i.e. between
326 linkgit:git-status[1]
330 linkgit:git-commit[1]
331 linkgit:git-update-index[1]
335 Written by Linus Torvalds <torvalds@osdl.org>
339 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
343 Part of the linkgit:git[1] suite
projects / git / blob