git-secret/man/man1/git-secret-init.1.md

44 lines
1.3 KiB
Markdown
Raw Normal View History

2016-02-21 13:26:17 +00:00
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.
2016-02-21 13:26:17 +00:00
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)](https://git-secret.io/git-secret) 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.
2016-02-21 13:26:17 +00:00
## OPTIONS
-h - shows this help.
## MANUAL
Run `man git-secret-init` to see this document.
2016-02-21 13:26:17 +00:00
## SEE ALSO
2021-06-26 14:17:37 +00:00
[git-secret-usage(1)](https://git-secret.io/git-secret-usage), [git-secret-tell(1)](https://git-secret.io/git-secret-tell)