git-annex/doc/git-annex-init.mdwn
Joey Hess 1bb32098d6
jump right to v8, don't stop part way
* init --version: When the version given is one that automatically
  upgrades to a newer version, use the newer version instead.
* Auto upgrades from older repo versions, like v5, now jump right to v8.
2020-02-24 13:21:00 -04:00

56 lines
1.6 KiB
Markdown

# NAME
git-annex init - initialize git-annex
# SYNOPSIS
git annex init `[description]`
# DESCRIPTION
Until a repository (or one of its remotes) has been initialized,
git-annex will refuse to operate on it, to avoid accidentally
using it in a repository that was not intended to have an annex.
It's useful, but not mandatory, to initialize each new clone
of a repository with its own description. If you don't provide one,
one will be generated using the username, hostname and the path.
If any special remotes were configured with autoenable=true,
this will also attempt to enable them. See [[git-annex-initremote]](1).
To disable this, re-enable a remote with "autoenable=false", or
mark it as dead (see [[git-annex-dead]](1)).
This command is entirely safe, although usually pointless, to run inside an
already initialized git-annex repository.
A top-level `.noannex` file will prevent git-annex init from being used
in a repository. This is useful for repositories that have a policy
reason not to use git-annex. The content of the file will be displayed
to the user who tries to run git-annex init.
# OPTIONS
* `--version=N`
Force the repository to be initialized using a different annex.version
than the current default.
When the version given is one that automatically upgrades to a newer
version, it will automatically use the newer version instead.
# SEE ALSO
[[git-annex]](1)
[[git-annex-describe]](1)
[[git-annex-reinit]](1)
git-init(1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.