commands.sh

yadm

all

A dotfiles manager that works by using `git`. Some subcommands such as `init`, `clone`, `push`, and `pull` have their own usage documentation.

More info →

Subcommands (14)

yadm alt

Create symbolic links and process templates for any managed files. Learn more about templates: <https://yadm.io/docs/templates>.

→
yadm bootstrap

Execute Yadm's bootstrap file. This file should be created in `$HOME/.config/yadm/bootstrap`.

→
yadm clone

Works just like `git clone`. In addition you can pass extra flags to configure your repository. If there is a bootstrap file in the repository, you will be prompted to execute it. See also: `git clone`.

→
yadm config

Pass options to yadm's config file. Change the `.config` of the repository managed by yadm.

→
yadm decrypt

Decrypt files that were encrypted by yadm. When activating this command you will be prompted for a password.

→
yadm encrypt

Encrypt files listed in the designated encrypt file. After the files are encrypted they will be save in the designated archive folder.

→
yadm enter

Run a sub-shell with all Git variables set. This sub-shell can be used to easily interact with the local yadm repository using Git commands. This could be useful if you are using a tool which uses Git directly.

→
yadm gitconfig

Pass options to `git config`. Change the `.gitconfig` of the repository managed by yadm. See also: `git config`.

→
yadm init

Initialize a new, empty repository for tracking dotfiles. The repository is stored in `$HOME/.local/share/yadm/repo.git`.

→
yadm introspect

Look at data that is managed by yadm. The purpose of introspection is to support command line completion.

→
yadm list

Print a list of files managed by yadm.

→
yadm perms

Update permissions. It is usually unnecessary to run this command, as yadm automatically processes permissions by default. This automatic behavior can be disabled by setting the configuration `yadm.auto-perms` to `"false"`.

→
yadm transcrypt

If `transcrypt` is installed, this command allows you to pass options directly to `transcrypt`. With the environment configured to use the yadm repository. Transcrypt enables transparent encryption and decryption of files in a Git repository.

→
yadm upgrade

Upgrade yadm to the latest version. Upgrading will attempt to de-initialize and re-initialize your submodules.

→

Examples (7)

Override yadm's configuration directory

yadm --yadm-dir

Override yadm's data directory. yadm stores its data relative to this directory

yadm --yadm-data

Override the location of the yadm repository

yadm --yadm-repo

Override the location of yadm's main configuration file

yadm --yadm-config

Override the location of the yadm encryption configuration

yadm --yadm-encrypt

Override the location of the yadm encrypted files archive

yadm --yadm-archive

Override the location of the yadm bootstrap program

yadm --yadm-bootstrap
made by @shridhargupta | data from tldr-pages