LinuxCommandLibrary

yadm-decrypt

Decrypt files managed by yadm

TLDR

Decrypt files

$ yadm decrypt
copy

SYNOPSIS

yadm decrypt [file...]

PARAMETERS

[file...]
    A list of files to decrypt. If no files are provided, all files ending in '.gpg' in the yadm repository will be decrypted.

DESCRIPTION

The `yadm-decrypt` command decrypts files that are encrypted and managed by yadm. Yadm is a tool for managing a single repository of dotfiles across multiple machines. It uses Git as its backend and allows for easy synchronization of configuration files. Encryption is achieved using `gpg`. `yadm-decrypt` reads each encrypted file, decrypts its content utilizing gpg with the relevant private key (usually passphrase protected), and replaces the encrypted file with the decrypted version. It typically operates on files with the `.gpg` extension. This is useful when you need to edit or directly access the content of those files on a system where yadm is managing them. This command is used in the opposite manner of `yadm-encrypt`, which encrypts the files.

CAVEATS

Requires a functional GPG setup with the appropriate private key available and unlocked if passphrase protected. Decrypted files are written in place, overwriting the encrypted versions.
This command assumes files ending in .gpg have been encrypted.

USAGE

Primarily used to make changes or edits to encrypted configuration files so changes can be pushed back.

SECURITY CONSIDERATIONS

The decrypted files are stored in plain text. Ensure appropriate file permissions are set to prevent unauthorized access to sensitive information within the decrypted files. It's recommended to encrypt the files again with `yadm encrypt` after any modifications have been completed.

SEE ALSO

yadm(1), yadm-encrypt(1), gpg(1)

Copied to clipboard