6 git-add - Add file contents to the index
11 'git add' [-n] [-v] [--force | -f] [--interactive | -i] [--patch | -p]
12 [--edit | -e] [--[no-]all | --[no-]ignore-removal | [--update | -u]]
13 [--intent-to-add | -N] [--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 update the index to
57 match the current state of the directory as a whole (e.g.
58 specifying `dir` will record not just a file `dir/file1`
59 modified in the working tree, a file `dir/file2` added to
60 the working tree, but also a file `dir/file3` removed from
61 the working tree. Note that older versions of Git used
62 to ignore removed files; use `--no-all` option if you want
63 to add modified or new files but ignore removed ones.
67 Don't actually add the file(s), just show if they exist and/or will
76 Allow adding otherwise ignored files.
80 Add modified contents in the working tree interactively to
81 the index. Optional path arguments may be supplied to limit
82 operation to a subset of the working tree. See ``Interactive
87 Interactively choose hunks of patch between the index and the
88 work tree and add them to the index. This gives the user a chance
89 to review the difference before adding modified contents to the
92 This effectively runs `add --interactive`, but bypasses the
93 initial command menu and directly jumps to the `patch` subcommand.
94 See ``Interactive mode'' for details.
97 Open the diff vs. the index in an editor and let the user
98 edit it. After the editor was closed, adjust the hunk headers
99 and apply the patch to the index.
101 The intent of this option is to pick and choose lines of the patch to
102 apply, or even to modify the contents of lines to be staged. This can be
103 quicker and more flexible than using the interactive hunk selector.
104 However, it is easy to confuse oneself and create a patch that does not
105 apply to the index. See EDITING PATCHES below.
109 Update the index just where it already has an entry matching
110 <pathspec>. This removes as well as modifies index entries to
111 match the working tree, but adds no new files.
113 If no <pathspec> is given when `-u` option is used, all
114 tracked files in the entire working tree are updated (old versions
115 of Git used to limit the update to the current directory and its
120 --no-ignore-removal::
121 Update the index not only where the working tree has a file
122 matching <pathspec> but also where the index already has an
123 entry. This adds, modifies, and removes index entries to
124 match the working tree.
126 If no <pathspec> is given when `-A` option is used, all
127 files in the entire working tree are updated (old versions
128 of Git used to limit the update to the current directory and its
133 Update the index by adding new files that are unknown to the
134 index and files modified in the working tree, but ignore
135 files that have been removed from the working tree. This
136 option is a no-op when no <pathspec> is used.
138 This option is primarily to help users who are used to older
139 versions of Git, whose "git add <pathspec>..." was a synonym
140 for "git add --no-all <pathspec>...", i.e. ignored removed files.
144 Record only the fact that the path will be added later. An entry
145 for the path is placed in the index with no content. This is
146 useful for, among other things, showing the unstaged content of
147 such files with `git diff` and committing them with `git commit
151 Don't add the file(s), but only refresh their stat()
152 information in the index.
155 If some files could not be added because of errors indexing
156 them, do not abort the operation, but continue adding the
157 others. The command shall still exit with non-zero status.
158 The configuration variable `add.ignoreErrors` can be set to
159 true to make this the default behaviour.
162 This option can only be used together with --dry-run. By using
163 this option the user can check if any of the given files would
164 be ignored, no matter if they are already present in the work
168 This option can be used to separate command-line options from
169 the list of files, (useful when filenames might be mistaken
170 for command-line options).
176 The optional configuration variable `core.excludesfile` indicates a path to a
177 file containing patterns of file names to exclude from git-add, similar to
178 $GIT_DIR/info/exclude. Patterns in the exclude file are used in addition to
179 those in info/exclude. See linkgit:gitignore[5].
185 * Adds content from all `*.txt` files under `Documentation` directory
186 and its subdirectories:
189 $ git add Documentation/\*.txt
192 Note that the asterisk `*` is quoted from the shell in this
193 example; this lets the command include the files from
194 subdirectories of `Documentation/` directory.
196 * Considers adding content from all git-*.sh scripts:
202 Because this example lets the shell expand the asterisk (i.e. you are
203 listing the files explicitly), it does not consider
208 When the command enters the interactive mode, it shows the
209 output of the 'status' subcommand, and then goes into its
210 interactive command loop.
212 The command loop shows the list of subcommands available, and
213 gives a prompt "What now> ". In general, when the prompt ends
214 with a single '>', you can pick only one of the choices given
215 and type return, like this:
219 1: status 2: update 3: revert 4: add untracked
220 5: patch 6: diff 7: quit 8: help
224 You also could say `s` or `sta` or `status` above as long as the
227 The main command loop has 6 subcommands (plus help and quit).
231 This shows the change between HEAD and index (i.e. what will be
232 committed if you say `git commit`), and between index and
233 working tree files (i.e. what you could stage further before
234 `git commit` using `git add`) for each path. A sample output
239 1: binary nothing foo.png
240 2: +403/-35 +1/-1 git-add--interactive.perl
243 It shows that foo.png has differences from HEAD (but that is
244 binary so line count cannot be shown) and there is no
245 difference between indexed copy and the working tree
246 version (if the working tree version were also different,
247 'binary' would have been shown in place of 'nothing'). The
248 other file, git-add{litdd}interactive.perl, has 403 lines added
249 and 35 lines deleted if you commit what is in the index, but
250 working tree file has further modifications (one addition and
255 This shows the status information and issues an "Update>>"
256 prompt. When the prompt ends with double '>>', you can
257 make more than one selection, concatenated with whitespace or
258 comma. Also you can say ranges. E.g. "2-5 7,9" to choose
259 2,3,4,5,7,9 from the list. If the second number in a range is
260 omitted, all remaining patches are taken. E.g. "7-" to choose
261 7,8,9 from the list. You can say '*' to choose everything.
263 What you chose are then highlighted with '*',
268 1: binary nothing foo.png
269 * 2: +403/-35 +1/-1 git-add--interactive.perl
272 To remove selection, prefix the input with `-`
279 After making the selection, answer with an empty line to stage the
280 contents of working tree files for selected paths in the index.
284 This has a very similar UI to 'update', and the staged
285 information for selected paths are reverted to that of the
286 HEAD version. Reverting new paths makes them untracked.
290 This has a very similar UI to 'update' and
291 'revert', and lets you add untracked paths to the index.
295 This lets you choose one path out of a 'status' like selection.
296 After choosing the path, it presents the diff between the index
297 and the working tree file and asks you if you want to stage
298 the change of each hunk. You can select one of the following
299 options and type return:
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.
319 You can omit having to type return here, by setting the configuration
320 variable `interactive.singlekey` to `true`.
324 This lets you review what will be committed (i.e. between
331 Invoking `git add -e` or selecting `e` from the interactive hunk
332 selector will open a patch in your editor; after the editor exits, the
333 result is applied to the index. You are free to make arbitrary changes
334 to the patch, but note that some changes may have confusing results, or
335 even result in a patch that cannot be applied. If you want to abort the
336 operation entirely (i.e., stage nothing new in the index), simply delete
337 all lines of the patch. The list below describes some common things you
338 may see in a patch, and which editing operations make sense on them.
343 Added content is represented by lines beginning with "{plus}". You can
344 prevent staging any addition lines by deleting them.
348 Removed content is represented by lines beginning with "-". You can
349 prevent staging their removal by converting the "-" to a " " (space).
353 Modified content is represented by "-" lines (removing the old content)
354 followed by "{plus}" lines (adding the replacement content). You can
355 prevent staging the modification by converting "-" lines to " ", and
356 removing "{plus}" lines. Beware that modifying only half of the pair is
357 likely to introduce confusing changes to the index.
360 There are also more complex operations that can be performed. But beware
361 that because the patch is applied only to the index and not the working
362 tree, the working tree will appear to "undo" the change in the index.
363 For example, introducing a new line into the index that is in neither
364 the HEAD nor the working tree will stage the new line for commit, but
365 the line will appear to be reverted in the working tree.
367 Avoid using these constructs, or do so with extreme caution.
370 removing untouched content::
372 Content which does not differ between the index and working tree may be
373 shown on context lines, beginning with a " " (space). You can stage
374 context lines for removal by converting the space to a "-". The
375 resulting working tree file will appear to re-add the content.
377 modifying existing content::
379 One can also modify context lines by staging them for removal (by
380 converting " " to "-") and adding a "{plus}" line with the new content.
381 Similarly, one can modify "{plus}" lines for existing additions or
382 modifications. In all cases, the new modification will appear reverted
387 You may also add new content that does not exist in the patch; simply
388 add new lines, each starting with "{plus}". The addition will appear
389 reverted in the working tree.
392 There are also several operations which should be avoided entirely, as
393 they will make the patch impossible to apply:
395 * adding context (" ") or removal ("-") lines
396 * deleting context or removal lines
397 * modifying the contents of context or removal lines
401 linkgit:git-status[1]
405 linkgit:git-commit[1]
406 linkgit:git-update-index[1]
410 Part of the linkgit:git[1] suite
projects / thirdparty / git.git / blob