1git-annex-init(1) General Commands Manual git-annex-init(1)
2
3
4
6 git-annex-init - initialize git-annex
7
9 git annex init [description]
10
12 Until a repository (or one of its remotes) has been initialized, git-
13 annex will refuse to operate on it, to avoid accidentally using it in a
14 repository that was not intended to have an annex.
15
16 It's useful, but not mandatory, to initialize each new clone of a
17 repository with its own description. If you don't provide one, one will
18 be generated using the username, hostname and the path.
19
20 If any special remotes were configured with autoenable=true, this will
21 also attempt to enable them. See git-annex-initremote(1). To prevent
22 that, re-enable a remote with "autoenable=false", or mark it as dead
23 (see git-annex-dead(1)).
24
25 This command is entirely safe, although usually pointless, to run in‐
26 side an already initialized git-annex repository.
27
28 A top-level .noannex file will prevent git-annex init from being used
29 in a repository. This is useful for repositories that have a policy
30 reason not to use git-annex. The content of the file will be displayed
31 to the user who tries to run git-annex init.
32
34 # git annex add foo
35 git-annex: First run: git-annex init
36 # git annex init
37 init ok
38 # git annex add foo
39 add foo ok
40
42 --version=N
43
44 Force the repository to be initialized using a different an‐
45 nex.version than the current default.
46
47 When the version given is not supported, but can be automati‐
48 cally upgraded to a newer version, it will use the newer version
49 instead.
50
51 --autoenable
52 Only enable any special remotes that were configured with au‐
53 toenable=true, do not otherwise initialize anything.
54
55 --no-autoenable
56 Do not enable special remotes that were configured with autoen‐
57 able=true.
58
59 --json Enable JSON output. This is intended to be parsed by programs
60 that use git-annex.
61
62 --json-error-messages
63 Messages that would normally be output to standard error are in‐
64 cluded in the JSON instead.
65
66 Also the git-annex-common-options(1) can be used.
67
69 git-annex(1)
70
71 git-annex-describe(1)
72
73 git-annex-reinit(1)
74
75 git-init(1)
76
78 Joey Hess <id@joeyh.name>
79
80 git-annex-init(1)