git-secret/man/man1/git-secret-init.1.md
Josh Rabinowitz 120edded4f
Cleanups 2022 04 (#824)
* change file desc we use to pass gnupg info
* improve content and phrasing in docs
* improve docs about locations of private/public keys
* update changelog
2022-04-14 19:07:52 -04:00

1.3 KiB

git-secret-init - initializes git-secret repository.

SYNOPSIS

git secret init

DESCRIPTION

git-secret-init - initializes a git-secret repo by setting up a .gitsecret directory.

git-secret-init should be run inside a git repo, to create the .gitsecret directory and initialize the repo for git-secret. Until a repository is initialized with git secret init, all other git-secret commands are unavailable.

If a .gitsecret directory already exists, git-secret-init exits without making any changes. Otherwise,

  • .gitignore is modified to ignore git-secret's random_seed_file, and to not ignore .secret files,

  • a .gitsecret directory is created with the sub-directories /keys and /paths,

  • The .gitsecret/keys subdirectory permission is set to 700 to make gnupg happy.

See git-secret(7) for information about renaming the .gitsecret folder with the SECRETS_DIR environment variable, and changing the extension git-secret uses for secret files with the SECRETS_EXTENSION environment variable.

OPTIONS

-h  - shows this help.

MANUAL

Run man git-secret-init to see this document.

SEE ALSO

git-secret-usage(1), git-secret-tell(1)