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