1git-add(1) 2========== 3 4NAME 5---- 6git-add - Add file contents to the index 7 8SYNOPSIS 9-------- 10[verse] 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] [--] [<filepattern>...] 14 15DESCRIPTION 16----------- 17This command adds the current content of new or modified files to the 18index, thus staging that content for inclusion in the next commit. 19 20The "index" holds a snapshot of the content of the working tree, and it 21is this snapshot that is taken as the contents of the next commit. Thus 22after making any changes to the working directory, and before running 23the commit command, you must use the 'add' command to add any new or 24modified files to the index. 25 26This command can be performed multiple times before a commit. It only 27adds the content of the specified file(s) at the time the add command is 28run; if you want subsequent changes included in the next commit, then 29you must run 'git add' again to add the new content to the index. 30 31The 'git status' command can be used to obtain a summary of which 32files have changes that are staged for the next commit. 33 34The 'git add' command will not add ignored files by default. If any 35ignored files were explicitly specified on the command line, 'git add' 36will fail with a list of ignored files. Ignored files reached by 37directory recursion or filename globbing performed by Git (quote your 38globs before the shell) will be silently ignored. The 'add' command can 39be used to add ignored files with the `-f` (force) option. 40 41Please see linkgit:git-commit[1] for alternative ways to add content to a 42commit. 43 44 45OPTIONS 46------- 47<filepattern>...:: 48 Files to add content from. Fileglobs (e.g. `*.c`) can 49 be given to add all matching files. Also a 50 leading directory name (e.g. `dir` to add `dir/file1` 51 and `dir/file2`) can be given to add all files in the 52 directory, recursively. 53 54-n:: 55--dry-run:: 56 Don't actually add the file(s), just show if they exist. 57 58-v:: 59--verbose:: 60 Be verbose. 61 62-f:: 63--force:: 64 Allow adding otherwise ignored files. 65 66-i:: 67--interactive:: 68 Add modified contents in the working tree interactively to 69 the index. Optional path arguments may be supplied to limit 70 operation to a subset of the working tree. See ``Interactive 71 mode'' for details. 72 73-p:: 74--patch:: 75 Interactively choose hunks of patch between the index and the 76 work tree and add them to the index. This gives the user a chance 77 to review the difference before adding modified contents to the 78 index. 79 80 This effectively runs ``add --interactive``, but bypasses the 81 initial command menu and directly jumps to `patch` subcommand. 82 See ``Interactive mode'' for details. 83 84-e, \--edit:: 85 Open the diff vs. the index in an editor and let the user 86 edit it. After the editor was closed, adjust the hunk headers 87 and apply the patch to the index. 88+ 89*NOTE*: Obviously, if you change anything else than the first character 90on lines beginning with a space or a minus, the patch will no longer 91apply. 92 93-u:: 94--update:: 95 Update only files that git already knows about, staging modified 96 content for commit and marking deleted files for removal. This 97 is similar 98 to what "git commit -a" does in preparation for making a commit, 99 except that the update is limited to paths specified on the 100 command line. If no paths are specified, all tracked files in the 101 current directory and its subdirectories are updated. 102 103-A:: 104--all:: 105 Update files that git already knows about (same as '\--update') 106 and add all untracked files that are not ignored by '.gitignore' 107 mechanism. 108 109 110-N:: 111--intent-to-add:: 112 Record only the fact that the path will be added later. An entry 113 for the path is placed in the index with no content. This is 114 useful for, among other things, showing the unstaged content of 115 such files with 'git diff' and committing them with 'git commit 116 -a'. 117 118--refresh:: 119 Don't add the file(s), but only refresh their stat() 120 information in the index. 121 122--ignore-errors:: 123 If some files could not be added because of errors indexing 124 them, do not abort the operation, but continue adding the 125 others. The command shall still exit with non-zero status. 126 127\--:: 128 This option can be used to separate command-line options from 129 the list of files, (useful when filenames might be mistaken 130 for command-line options). 131 132 133Configuration 134------------- 135 136The optional configuration variable 'core.excludesfile' indicates a path to a 137file containing patterns of file names to exclude from git-add, similar to 138$GIT_DIR/info/exclude. Patterns in the exclude file are used in addition to 139those in info/exclude. See linkgit:gitrepository-layout[5]. 140 141 142EXAMPLES 143-------- 144 145* Adds content from all `\*.txt` files under `Documentation` directory 146and its subdirectories: 147+ 148------------ 149$ git add Documentation/\\*.txt 150------------ 151+ 152Note that the asterisk `\*` is quoted from the shell in this 153example; this lets the command include the files from 154subdirectories of `Documentation/` directory. 155 156* Considers adding content from all git-*.sh scripts: 157+ 158------------ 159$ git add git-*.sh 160------------ 161+ 162Because this example lets the shell expand the asterisk (i.e. you are 163listing the files explicitly), it does not consider 164`subdir/git-foo.sh`. 165 166Interactive mode 167---------------- 168When the command enters the interactive mode, it shows the 169output of the 'status' subcommand, and then goes into its 170interactive command loop. 171 172The command loop shows the list of subcommands available, and 173gives a prompt "What now> ". In general, when the prompt ends 174with a single '>', you can pick only one of the choices given 175and type return, like this: 176 177------------ 178 *** Commands *** 179 1: status 2: update 3: revert 4: add untracked 180 5: patch 6: diff 7: quit 8: help 181 What now> 1 182------------ 183 184You also could say "s" or "sta" or "status" above as long as the 185choice is unique. 186 187The main command loop has 6 subcommands (plus help and quit). 188 189status:: 190 191 This shows the change between HEAD and index (i.e. what will be 192 committed if you say "git commit"), and between index and 193 working tree files (i.e. what you could stage further before 194 "git commit" using "git-add") for each path. A sample output 195 looks like this: 196+ 197------------ 198 staged unstaged path 199 1: binary nothing foo.png 200 2: +403/-35 +1/-1 git-add--interactive.perl 201------------ 202+ 203It shows that foo.png has differences from HEAD (but that is 204binary so line count cannot be shown) and there is no 205difference between indexed copy and the working tree 206version (if the working tree version were also different, 207'binary' would have been shown in place of 'nothing'). The 208other file, git-add--interactive.perl, has 403 lines added 209and 35 lines deleted if you commit what is in the index, but 210working tree file has further modifications (one addition and 211one deletion). 212 213update:: 214 215 This shows the status information and issues an "Update>>" 216 prompt. When the prompt ends with double '>>', you can 217 make more than one selection, concatenated with whitespace or 218 comma. Also you can say ranges. E.g. "2-5 7,9" to choose 219 2,3,4,5,7,9 from the list. If the second number in a range is 220 omitted, all remaining patches are taken. E.g. "7-" to choose 221 7,8,9 from the list. You can say '*' to choose everything. 222+ 223What you chose are then highlighted with '*', 224like this: 225+ 226------------ 227 staged unstaged path 228 1: binary nothing foo.png 229* 2: +403/-35 +1/-1 git-add--interactive.perl 230------------ 231+ 232To remove selection, prefix the input with `-` 233like this: 234+ 235------------ 236Update>> -2 237------------ 238+ 239After making the selection, answer with an empty line to stage the 240contents of working tree files for selected paths in the index. 241 242revert:: 243 244 This has a very similar UI to 'update', and the staged 245 information for selected paths are reverted to that of the 246 HEAD version. Reverting new paths makes them untracked. 247 248add untracked:: 249 250 This has a very similar UI to 'update' and 251 'revert', and lets you add untracked paths to the index. 252 253patch:: 254 255 This lets you choose one path out of a 'status' like selection. 256 After choosing the path, it presents the diff between the index 257 and the working tree file and asks you if you want to stage 258 the change of each hunk. You can say: 259 260 y - stage this hunk 261 n - do not stage this hunk 262 q - quit, do not stage this hunk nor any of the remaining ones 263 a - stage this and all the remaining hunks in the file 264 d - do not stage this hunk nor any of the remaining hunks in the file 265 g - select a hunk to go to 266 / - search for a hunk matching the given regex 267 j - leave this hunk undecided, see next undecided hunk 268 J - leave this hunk undecided, see next hunk 269 k - leave this hunk undecided, see previous undecided hunk 270 K - leave this hunk undecided, see previous hunk 271 s - split the current hunk into smaller hunks 272 e - manually edit the current hunk 273 ? - print help 274+ 275After deciding the fate for all hunks, if there is any hunk 276that was chosen, the index is updated with the selected hunks. 277 278diff:: 279 280 This lets you review what will be committed (i.e. between 281 HEAD and index). 282 283SEE ALSO 284-------- 285linkgit:git-status[1] 286linkgit:git-rm[1] 287linkgit:git-reset[1] 288linkgit:git-mv[1] 289linkgit:git-commit[1] 290linkgit:git-update-index[1] 291 292Author 293------ 294Written by Linus Torvalds <torvalds@osdl.org> 295 296Documentation 297-------------- 298Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. 299 300GIT 301--- 302Part of the linkgit:git[1] suite