1GIT-ADD(1) Git Manual GIT-ADD(1)
2
6 git-add - Add file contents to the index
7
9 git add [--verbose | -v] [--dry-run | -n] [--force | -f] [--interactive | -i] [--patch | -p]
10 [--edit | -e] [--[no-]all | --[no-]ignore-removal | [--update | -u]]
11 [--intent-to-add | -N] [--refresh] [--ignore-errors] [--ignore-missing] [--renormalize]
12 [--chmod=(+|-)x] [--] [<pathspec>...]
13
16 This command updates the index using the current content found in the
17 working tree, to prepare the content staged for the next commit. It
18 typically adds the current content of existing paths as a whole, but
19 with some options it can also be used to add content with only part of
20 the changes made to the working tree files applied, or remove paths
21 that do not exist in the working tree anymore.
22 The "index" holds a snapshot of the content of the working tree, and it
24 is this snapshot that is taken as the contents of the next commit. Thus
25 after making any changes to the working tree, and before running the
26 commit command, you must use the add command to add any new or modified
27 files to the index.
28 This command can be performed multiple times before a commit. It only
30 adds the content of the specified file(s) at the time the add command
31 is run; if you want subsequent changes included in the next commit,
32 then you must run git add again to add the new content to the index.
33 The git status command can be used to obtain a summary of which files
35 have changes that are staged for the next commit.
36 The git add command will not add ignored files by default. If any
38 ignored files were explicitly specified on the command line, git add
39 will fail with a list of ignored files. Ignored files reached by
40 directory recursion or filename globbing performed by Git (quote your
41 globs before the shell) will be silently ignored. The git add command
42 can be used to add ignored files with the -f (force) option.
43 Please see git-commit(1) for alternative ways to add content to a
45 commit.
46
48 <pathspec>...
49 Files to add content from. Fileglobs (e.g. *.c) can be given to
50 add all matching files. Also a leading directory name (e.g. dir to
51 add dir/file1 and dir/file2) can be given to update the index to
52 match the current state of the directory as a whole (e.g.
53 specifying dir will record not just a file dir/file1 modified in
54 the working tree, a file dir/file2 added to the working tree, but
55 also a file dir/file3 removed from the working tree). Note that
56 older versions of Git used to ignore removed files; use --no-all
57 option if you want to add modified or new files but ignore removed
58 ones.
59 For more details about the <pathspec> syntax, see the pathspec
61 entry in gitglossary(7).
62 -n, --dry-run
64 Don’t actually add the file(s), just show if they exist and/or will
65 be ignored.
66 -v, --verbose
68 Be verbose.
69 -f, --force
71 Allow adding otherwise ignored files.
72 -i, --interactive
74 Add modified contents in the working tree interactively to the
75 index. Optional path arguments may be supplied to limit operation
76 to a subset of the working tree. See “Interactive mode” for
77 details.
78 -p, --patch
80 Interactively choose hunks of patch between the index and the work
81 tree and add them to the index. This gives the user a chance to
82 review the difference before adding modified contents to the index.
83 This effectively runs add --interactive, but bypasses the initial
85 command menu and directly jumps to the patch subcommand. See
86 “Interactive mode” for details.
87 -e, --edit
89 Open the diff vs. the index in an editor and let the user edit it.
90 After the editor was closed, adjust the hunk headers and apply the
91 patch to the index.
92 The intent of this option is to pick and choose lines of the patch
94 to apply, or even to modify the contents of lines to be staged.
95 This can be quicker and more flexible than using the interactive
96 hunk selector. However, it is easy to confuse oneself and create a
97 patch that does not apply to the index. See EDITING PATCHES below.
98 -u, --update
100 Update the index just where it already has an entry matching
101 <pathspec>. This removes as well as modifies index entries to match
102 the working tree, but adds no new files.
103 If no <pathspec> is given when -u option is used, all tracked files
105 in the entire working tree are updated (old versions of Git used to
106 limit the update to the current directory and its subdirectories).
107 -A, --all, --no-ignore-removal
109 Update the index not only where the working tree has a file
110 matching <pathspec> but also where the index already has an entry.
111 This adds, modifies, and removes index entries to match the working
112 tree.
113 If no <pathspec> is given when -A option is used, all files in the
115 entire working tree are updated (old versions of Git used to limit
116 the update to the current directory and its subdirectories).
117 --no-all, --ignore-removal
119 Update the index by adding new files that are unknown to the index
120 and files modified in the working tree, but ignore files that have
121 been removed from the working tree. This option is a no-op when no
122 <pathspec> is used.
123 This option is primarily to help users who are used to older
125 versions of Git, whose "git add <pathspec>..." was a synonym for
126 "git add --no-all <pathspec>...", i.e. ignored removed files.
127 -N, --intent-to-add
129 Record only the fact that the path will be added later. An entry
130 for the path is placed in the index with no content. This is useful
131 for, among other things, showing the unstaged content of such files
132 with git diff and committing them with git commit -a.
133 --refresh
135 Don’t add the file(s), but only refresh their stat() information in
136 the index.
137 --ignore-errors
139 If some files could not be added because of errors indexing them,
140 do not abort the operation, but continue adding the others. The
141 command shall still exit with non-zero status. The configuration
142 variable add.ignoreErrors can be set to true to make this the
143 default behaviour.
144 --ignore-missing
146 This option can only be used together with --dry-run. By using this
147 option the user can check if any of the given files would be
148 ignored, no matter if they are already present in the work tree or
149 not.
150 --no-warn-embedded-repo
152 By default, git add will warn when adding an embedded repository to
153 the index without using git submodule add to create an entry in
154 .gitmodules. This option will suppress the warning (e.g., if you
155 are manually performing operations on submodules).
156 --renormalize
158 Apply the "clean" process freshly to all tracked files to forcibly
159 add them again to the index. This is useful after changing
160 core.autocrlf configuration or the text attribute in order to
161 correct files added with wrong CRLF/LF line endings. This option
162 implies -u.
163 --chmod=(+|-)x
165 Override the executable bit of the added files. The executable bit
166 is only changed in the index, the files on disk are left unchanged.
167 --
169 This option can be used to separate command-line options from the
170 list of files, (useful when filenames might be mistaken for
171 command-line options).
172
174 · Adds content from all *.txt files under Documentation directory and
175 its subdirectories:
176 $ git add Documentation/\*.txt
178 Note that the asterisk * is quoted from the shell in this example;
180 this lets the command include the files from subdirectories of
181 Documentation/ directory.
182 · Considers adding content from all git-*.sh scripts:
184 $ git add git-*.sh
186 Because this example lets the shell expand the asterisk (i.e. you
188 are listing the files explicitly), it does not consider
189 subdir/git-foo.sh.
190
192 When the command enters the interactive mode, it shows the output of
193 the status subcommand, and then goes into its interactive command loop.
194 The command loop shows the list of subcommands available, and gives a
196 prompt "What now> ". In general, when the prompt ends with a single >,
197 you can pick only one of the choices given and type return, like this:
198 *** Commands ***
200 1: status 2: update 3: revert 4: add untracked
201 5: patch 6: diff 7: quit 8: help
202 What now> 1
203 You also could say s or sta or status above as long as the choice is
206 unique.
207 The main command loop has 6 subcommands (plus help and quit).
209 status
211 This shows the change between HEAD and index (i.e. what will be
212 committed if you say git commit), and between index and working
213 tree files (i.e. what you could stage further before git commit
214 using git add) for each path. A sample output looks like this:
215 staged unstaged path
217 1: binary nothing foo.png
218 2: +403/-35 +1/-1 git-add--interactive.perl
219 It shows that foo.png has differences from HEAD (but that is binary
221 so line count cannot be shown) and there is no difference between
222 indexed copy and the working tree version (if the working tree
223 version were also different, binary would have been shown in place
224 of nothing). The other file, git-add--interactive.perl, has 403
225 lines added and 35 lines deleted if you commit what is in the
226 index, but working tree file has further modifications (one
227 addition and one deletion).
228 update
230 This shows the status information and issues an "Update>>" prompt.
231 When the prompt ends with double >>, you can make more than one
232 selection, concatenated with whitespace or comma. Also you can say
233 ranges. E.g. "2-5 7,9" to choose 2,3,4,5,7,9 from the list. If the
234 second number in a range is omitted, all remaining patches are
235 taken. E.g. "7-" to choose 7,8,9 from the list. You can say * to
236 choose everything.
237 What you chose are then highlighted with *, like this:
239 staged unstaged path
241 1: binary nothing foo.png
242 * 2: +403/-35 +1/-1 git-add--interactive.perl
243 To remove selection, prefix the input with - like this:
245 Update>> -2
247 After making the selection, answer with an empty line to stage the
249 contents of working tree files for selected paths in the index.
250 revert
252 This has a very similar UI to update, and the staged information
253 for selected paths are reverted to that of the HEAD version.
254 Reverting new paths makes them untracked.
255 add untracked
257 This has a very similar UI to update and revert, and lets you add
258 untracked paths to the index.
259 patch
261 This lets you choose one path out of a status like selection. After
262 choosing the path, it presents the diff between the index and the
263 working tree file and asks you if you want to stage the change of
264 each hunk. You can select one of the following options and type
265 return:
266 y - stage this hunk
268 n - do not stage this hunk
269 q - quit; do not stage this hunk or any of the remaining ones
270 a - stage this hunk and all later hunks in the file
271 d - do not stage this hunk or any of the later hunks in the file
272 g - select a hunk to go to
273 / - search for a hunk matching the given regex
274 j - leave this hunk undecided, see next undecided hunk
275 J - leave this hunk undecided, see next hunk
276 k - leave this hunk undecided, see previous undecided hunk
277 K - leave this hunk undecided, see previous hunk
278 s - split the current hunk into smaller hunks
279 e - manually edit the current hunk
280 ? - print help
281 After deciding the fate for all hunks, if there is any hunk that
283 was chosen, the index is updated with the selected hunks.
284 You can omit having to type return here, by setting the
286 configuration variable interactive.singleKey to true.
287 diff
289 This lets you review what will be committed (i.e. between HEAD and
290 index).
291
293 Invoking git add -e or selecting e from the interactive hunk selector
294 will open a patch in your editor; after the editor exits, the result is
295 applied to the index. You are free to make arbitrary changes to the
296 patch, but note that some changes may have confusing results, or even
297 result in a patch that cannot be applied. If you want to abort the
298 operation entirely (i.e., stage nothing new in the index), simply
299 delete all lines of the patch. The list below describes some common
300 things you may see in a patch, and which editing operations make sense
301 on them.
302 added content
304 Added content is represented by lines beginning with "+". You can
305 prevent staging any addition lines by deleting them.
306 removed content
308 Removed content is represented by lines beginning with "-". You can
309 prevent staging their removal by converting the "-" to a " "
310 (space).
311 modified content
313 Modified content is represented by "-" lines (removing the old
314 content) followed by "+" lines (adding the replacement content).
315 You can prevent staging the modification by converting "-" lines to
316 " ", and removing "+" lines. Beware that modifying only half of the
317 pair is likely to introduce confusing changes to the index.
318 There are also more complex operations that can be performed. But
320 beware that because the patch is applied only to the index and not the
321 working tree, the working tree will appear to "undo" the change in the
322 index. For example, introducing a new line into the index that is in
323 neither the HEAD nor the working tree will stage the new line for
324 commit, but the line will appear to be reverted in the working tree.
325 Avoid using these constructs, or do so with extreme caution.
327 removing untouched content
329 Content which does not differ between the index and working tree
330 may be shown on context lines, beginning with a " " (space). You
331 can stage context lines for removal by converting the space to a
332 "-". The resulting working tree file will appear to re-add the
333 content.
334 modifying existing content
336 One can also modify context lines by staging them for removal (by
337 converting " " to "-") and adding a "+" line with the new content.
338 Similarly, one can modify "+" lines for existing additions or
339 modifications. In all cases, the new modification will appear
340 reverted in the working tree.
341 new content
343 You may also add new content that does not exist in the patch;
344 simply add new lines, each starting with "+". The addition will
345 appear reverted in the working tree.
346 There are also several operations which should be avoided entirely, as
348 they will make the patch impossible to apply:
349 · adding context (" ") or removal ("-") lines
351 · deleting context or removal lines
353 · modifying the contents of context or removal lines
355
357 git-status(1) git-rm(1) git-reset(1) git-mv(1) git-commit(1) git-
358 update-index(1)
359
361 Part of the git(1) suite
362Git 2.24.1 12/10/2019 GIT-ADD(1)