Metadata-Version: 2.4
Name: vaultdir
Version: 0.0.7
Summary: Encrypt and decrypt directories with a password
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: cryptography>=47.0.0

# vaultdir

`vaultdir` encrypts a directory into a single password-protected `.vault` file and can decrypt it again later.

## Install

```bash
uv tool install git+https://github.com/diversen/vaultdir.git
```

## Upgrade

```bash
uv tool install --upgrade git+https://github.com/diversen/vaultdir.git
```

## Usage

Encrypt a directory:

```bash
vaultdir some-dir
```

This creates `./some-dir.vault` in the current working directory.

Decrypt a vault:

```bash
vaultdir some-dir.vault
```

This restores the archived directory in the current directory. For example,
`some-dir.vault` created from `some-dir` restores to `./some-dir`.

## Options

```bash
vaultdir some-dir -o backup.vault
vaultdir backup.vault -o restored-dir
vaultdir backup.vault -o restored-dir --force
```

When the source is a vault file, `-o restored-dir` restores the archive directly into
`restored-dir`.

## Notes

- The password is prompted interactively and is not passed on the command line.
- Existing output files or directories are not overwritten unless `--force` is used.
- The archive is encrypted with `scrypt` for key derivation and `AES-256-GCM` for authenticated encryption.
- Security details: [docs.md](./docs.md)
- Legal note: [legal.md](./legal.md)
