LinuxCommandLibrary

yadm-list

List files managed by yadm

TLDR

Print a list of files managed by yadm in the current directory

$ yadm list
copy

List all files managed by yadm completely
$ yadm list -a
copy

SYNOPSIS

yadm list

DESCRIPTION

The `yadm-list` command is used within the YADM (Yet Another Dotfiles Manager) environment to display a list of files and directories currently under YADM's control. This command provides a convenient way to see what files are being tracked and managed by YADM for backup, version control, and deployment across multiple systems. It effectively shows you what files YADM will link or copy into your home directory or other locations when you run `yadm clone` or `yadm pull`. The output typically includes the relative paths of the files within the YADM repository, making it easy to verify the configuration and ensure that all desired dotfiles are being properly managed.
The primary purpose is informational, allowing users to quickly inspect their YADM configuration. It does not modify any files or configurations. The list reflects the current state of the YADM repository, so any changes made within the repository must be committed and pushed for them to be reflected in the output of `yadm-list` across different systems. It allows to easily inspect what files yadm actually tracks and manages.

CAVEATS

The output of `yadm-list` depends on the current YADM configuration. If you have conditional files based on hostnames or other factors, the listed files may not be present on all systems where YADM is used.

OUTPUT FORMAT

The output is usually a simple list of file and directory paths, one per line. The paths are relative to the root of the YADM repository.

USAGE EXAMPLE

To list all tracked files, simply run `yadm list`. The output will be printed to the standard output.

SEE ALSO

yadm(1), yadm-clone(1), yadm-pull(1), yadm-status(1)

Copied to clipboard