LinuxCommandLibrary

yadm-config

Manage YADM (Yet Another Dotfiles Manager) configuration

TLDR

Set or update a yadm's Git configuration

$ yadm config [key.inner-key] [value]
copy

Get a value from yadm's Git configuration
$ yadm config --get [key]
copy

Unset a value in yadm's Git configuration
$ yadm config --unset [key]
copy

List all values in yadm's Git configuration
$ yadm config --list
copy

SYNOPSIS

yadm config [git command] [options]

PARAMETERS

git command
    The Git command to execute (e.g., `add`, `commit`, `push`, `pull`, `branch`). All standard Git commands are supported.

options
    Options specific to the Git command being executed. These are the standard Git options for the given command.

DESCRIPTION

The `yadm-config` command is part of the yadm (Yet Another Dotfiles Manager) suite. It's a crucial command allowing users to interact directly with the backing Git repository used to manage their dotfiles. Instead of directly using `git`, `yadm-config` provides a yadm-aware interface. Common uses include: manually adding files (beyond the automated process), making commits with specific messages, branching, merging, and other typical Git operations. This is most useful for advanced users who understand Git well. The command simplifies tasks and avoids interference between yadm's operations and direct user interaction.

Key functionalities include: accessing all underlying Git functionalities, managing branches and commits, viewing the history of configuration files, resolving conflicts, and pushing changes to remote repositories.

Ultimately, `yadm-config` provides fine-grained control over the configuration management process. It is recommended to fully understand both Git and yadm before using it.

CAVEATS

Using `yadm-config` improperly can lead to conflicts or data loss in your dotfiles repository. It is crucial to understand the Git commands you are using before executing them through `yadm-config`. Make sure to avoid doing things that might conflict with yadm's normal operation, such as removing files it needs to function.

EXAMPLES

Add a file: `yadm config add ~/.bashrc`
Commit changes: `yadm config commit -m "Updated bashrc with new aliases"`
Push to remote: `yadm config push origin main`
Create a new branch: `yadm config branch feature/new-config`

HISTORY

The `yadm-config` command was introduced as part of the yadm project, to provide users with more direct control over the Git repository that manages their dotfiles. It allows advanced users to manage their configurations with the flexibility and power of Git, while maintaining the convenience of yadm for everyday tasks.

SEE ALSO

yadm(1), git(1)

Copied to clipboard