docs/reference/derivepassphrase-export-vault.1.md (4fc0971) - derivepassphrase.git

derivepassphrase-export-vault.1.md

# derivepassphrase-export-vault(1)

## NAME

derivepassphrase-export-vault – export a vault-native configuration to standard output

## SYNOPSIS

````
derivepassphrase export vault [-f FMT] [-k K] PATH
````

## DESCRIPTION

Read the vault(1)-native configuration at PATH, extract all information from it, and export the resulting configuration to standard output (as if using vault(1)'s --export option).
Depending on the configuration format, this may either be a file or a directory.
Supports the vault(1) `v0.2`, `v0.3` and `storeroom` formats, all of which inherently use encryption and integrity protection.

If PATH is explicitly given as `VAULT_PATH`, then use the `VAULT_PATH` environment variable to determine the correct path.
(Use `./VAULT_PATH` or similar to indicate a file/directory actually named `VAULT_PATH`.)

## OPTIONS

-f, --format FMT
: Try the storage format FMT.
 May be given multiple times; the formats will be tried in order.

By default, we first try `v0.3`, then `v0.2`, and finally `storeroom`.

-k, --key K
: Use K as the storage master key.

By default, we check the `VAULT_KEY`, `LOGNAME`, `USER` and `USERNAME` environment variables, and use the first one with a proper value (*and only the first one*).

--debug
: Emit all diagnostic information to standard error, including progress, warning and error messages.

Cancels the effect of any previous --quiet or --verbose options.

-v, --verbose
: Emit extra/progress information to standard error, on top of warning and error messages.

Cancels the effect of any previous --debug or --quiet options.

-q, --quiet
: Suppress all other diagnostic output to standard error, except error messages.
 This includes warning messages.

Cancels the effect of any previous --debug or --verbose options.

--version
: Show version and feature information, then exit.

This includes a list of known foreign configuration formats and enabled PEP 508 extras (named sets of optional dependencies), marked explicitly as either supported or unavailable.

-h, --help
: Show a help message, then exit.

## ENVIRONMENT

`DERIVEPASSPHRASE_PATH`
: derivepassphrase stores its configuration files and data in this directory.
 Defaults to `~/.derivepassphrase` on UNIX-like systems and `C:\Users\<user>\AppData\Roaming\Derivepassphrase` on Windows.

`VAULT_PATH`
:   A default path, relative to the home directory, where to look for the configuration to load.

`VAULT_KEY`
:   A password with which the vault configuration is encrypted.
    The password is interpreted as a UTF-8 byte string.

`LOGNAME`, `USER`, `USERNAME`
:   Fallback values for `VAULT_KEY`.

## DIAGNOSTICS

The derivepassphrase export vault utility exits 0 on success, and >0 if an error occurs.

### Fatal error messages on standard error

(`%s` indicates a variable part of the message.)

??? failure "`Cannot parse %s as a valid vault-native configuration file/directory`"

The file or directory is not a valid vault-native configuration.
    Alternatively, the wrong format was assumed and/or the wrong master key was provided.

??? failure "`Invalid vault config: %s`"

The file or directory was successfully decrypted and decoded, but the resulting contents are not valid as a vault configuration.

??? failure "`Cannot load the required Python module %s`"

(Exactly what it says.)

## COMPATIBILITY

### With other software

derivepassphrase export vault fully supports reading the configuration formats used by vault(1) v0.3 and lower (formats `v0.2` and `v0.3`), as well as the `storeroom` format used in development builds after vault(1) v0.3 (`storeroom` version 1).

There is no corresponding "import" subcommand, nor is there support for writing configuration files or directories in any of the aforementioned formats.

## SEE ALSO

[derivepassphrase(1)](derivepassphrase.1.md),
[vault(1)](https://www.npmjs.com/package/vault).

## AUTHOR

[Marco Ricci](https://the13thletter.info) (`software` at `the13thletter` dot `info`)

## BUGS

* There is no support for writing vault(1) configuration files or directories in any of the aforementioned formats.

WONTFIX: two-way interoperability of configuration file disk formats is currently out of scope.
 Use the standard `--import` and `--export` options of both vault(1) and derivepassphrase vault.

derivepassphrase.git

Fix typos in the documentation