LinuxCommandLibrary

yadm-introspect

Inspect a repository for yadm compatibility

TLDR

Output commands

$ yadm introspect commands
copy

Output configs
$ yadm introspect configs
copy

Output switches for the main yadm command
$ yadm introspect switches
copy

Output repo
$ yadm introspect repo
copy

SYNOPSIS

`yadm-introspect [options] [path...]`

PARAMETERS

`--help`
    Display help message and exit.

`--version`
    Display version information and exit.

`--all`
    Introspect all files. By default, only files within the source directory (e.g. '~/.config') are introspected.

DESCRIPTION

The `yadm-introspect` command provides a way to examine the contents of a yadm-managed repository without needing to fully check it out into a working directory. This is useful for scripting, debugging, or simply understanding the structure of a yadm repository. It allows you to list files, view file contents, and get information about specific files or directories managed by yadm. This can be helpful when dealing with complex configurations or wanting to quickly inspect configurations across multiple machines managed by yadm.

It's essentially a read-only interface to the yadm repository, allowing for non-destructive querying and exploration of the files and directories tracked by yadm.

The introspected yadm repository is the one at the location managed by yadm. Specifically the introspected files are from the last yadm commit.

CAVEATS

Requires that yadm is properly initialized and manages the desired repository.

PATHS

If no paths are specified on the command line, all files in the repository are listed. If paths are specified, only files matching those paths (or files under those directories) are listed.

EXIT STATUS

The command returns 0 on success, and a non-zero value on failure.

SEE ALSO

yadm(1), git(1)

Copied to clipboard