git-annex-config(1)

1git-annex-config(1)         General Commands Manual        git-annex-config(1)
2
3
4

NAME

6       git-annex-config - configuration stored in git-annex branch
7

SYNOPSIS

9       git annex config --set name value
10
11       git annex config --get name
12
13       git annex config --unset name
14

DESCRIPTION

16       Set or get configuration settings stored in the git-annex branch.
17
18       Unlike git config settings, these settings can be seen in all clones of
19       the repository, once they have gotten their git-annex branches in sync.
20
21       These settings can be overridden on a per-repository  basis  using  git
22       config.
23
24       git-annex  does  not  check the git-annex branch for all the git config
25       settings that affect it (which are listed on  the  git-annex  man  page
26       CONFIGURATION  section).  Only  a few make sense to be able to set such
27       that all clones of a repository see the setting, and so git-annex  only
28       looks for these.
29

SUPPORTED SETTINGS

31       annex.largefiles
32
33              Used  to  configure  which files are large enough to be added to
34              the annex.  It is an expression that matches the large files, eg
35              "include=*.mp3   or  largerthan(500kb)".   See  git-annex-match‐
36              ing-expression(1) for details on the syntax.
37
38              This sets a default, which can be overridden by annex.largefiles
39              attributes in .gitattributes files, or by git config.
40
41       annex.dotfiles
42              Normally,  dotfiles  are  assumed  to  be files like .gitignore,
43              whose content should always be part of the  git  repository,  so
44              they  will  not be added to the annex. Setting annex.dotfiles to
45              true makes dotfiles be added to the annex the same as any  other
46              file.
47
48              This  sets  a default, which can be overridden by annex.dotfiles
49              in git config.
50
51       annex.addunlocked
52              Commands like git-annex add  default  to  adding  files  to  the
53              repository  in  locked form. This can make them add the files in
54              unlocked form, the same as if git-annex-unlock(1)  were  run  on
55              the files.
56
57              This  can be set to "true" to add everything unlocked, or it can
58              be a more complicated expression that  matches  files  by  name,
59              size,  or  content. See git-annex-matching-expression(1) for de‐
60              tails.
61
62              This sets a default, which can  be  overridden  by  annex.addun‐
63              locked in git config.
64
65       annex.autocommit
66              Set  to  false  to prevent the git-annex assistant and git-annex
67              sync from automatically  committing  changes  to  files  in  the
68              repository.
69
70              This sets a default, which can be overridden by annex.autocommit
71              in git config.
72
73       annex.resolvemerge
74              Set to false to prevent  merge  conflicts  in  the  checked  out
75              branch  being  automatically resolved by the git-annex assitant,
76              git-annex sync, git-annex merge, and the git-annex  post-receive
77              hook.
78
79              This  sets  a default, which can be overridden by annex.resolve‐
80              merge in git config.
81
82       annex.synccontent
83              Set to true to make git-annex sync default  to  syncing  annexed
84              content.
85
86              This  sets  a default, which can be overridden by annex.synccon‐
87              tent in git config.
88
89       annex.synconlyannex
90              Set to true to make git-annex sync default to only sync the git-
91              annex branch and annexed content.
92
93              This  sets  a  default,  which  can  be overridden by annex.syn‐
94              conlyannex in git config.
95
96       annex.securehashesonly
97              Set to true to indicate that  the  repository  should  only  use
98              cryptographically  secure  hashes  (SHA2, SHA3) and not insecure
99              hashes (MD5, SHA1) for content.
100
101              When this is set, the contents of files using  cryptographically
102              insecure  hashes  will not be allowed to be added to the reposi‐
103              tory.
104
105              Also, git-annex fsck will complain about any  files  present  in
106              the repository that use insecure hashes.
107
108              Note that this is only read from the git-annex branch by git an‐
109              nex init, and is copied to the corresponding git config setting.
110              So,  changes to the value in the git-annex branch won't affect a
111              repository once it has been initialized.
112

OPTIONS

114       --set name value
115
116              Set a value.
117
118       --get name
119              Get a value.
120
121       --unset
122              Unset a value.
123
124       Also the git-annex-common-options(1) can be used.
125

EXAMPLE

127       Suppose you want to prevent git annex sync from committing  changes  to
128       files,  so  a  manual  git commit workflow is used in all clones of the
129       repository. Then run:
130
131        git annex config --set annex.autocommit false
132
133       If you want to override that in a partiticular clone, just use git con‐
134       fig in the clone:
135
136        git config annex.autocommit true
137
138       And to get back to the default behavior:
139
140        git annex config --unset annex.autocommit
141

AUTHOR

150       Joey Hess <id@joeyh.name>
151
152                                                           git-annex-config(1)