lnk — Effortlessly manage your dotfiles with Git.

Pitch

Description

Comments

About this project

Lnk simplifies dotfiles management using Git by automating symlinking and conflict handling. Move your configurations to a dedicated repo, edit them like usual, and let lnk track changes seamlessly. Perfect for both new setups and routine edits, it streamlines your workflow without the hassle.

Lnk is a streamlined solution for managing dotfiles using Git, designed to simplify the process of organizing your configuration files without unnecessary complexity. By moving dotfiles to a dedicated directory (~/.config/lnk) and utilizing symbolic links, Lnk allows for a seamless integration with Git workflows.

Key Features

Easy Setup: Initialize your dotfiles management with a simple command.
```
lnk init
```
Add Existing Files: Quickly add your configuration files to the management system.
```
lnk add ~/.vimrc ~/.bashrc
```
Sync Changes Effortlessly: Push updates to your remote repository and pull changes as needed.
```
lnk push "setup"
lnk pull
```

How It Works

Lnk operates by relocating your dotfiles to the ~/.config/lnk directory and creating symlinks back to their original locations, allowing you to edit and manage files as usual while maintaining version control through Git.

Daily Workflow

Monitor changes made to your dotfiles with ease:
```
lnk status
```
Commit updates when necessary:
```
lnk push "new edits"
```

Advanced Usage

Lnk also offers advanced options for initial setup with existing repositories, making it convenient to manage configurations across different machines. For example, to set up a fresh environment or clone existing dotfiles from a remote repository:

lnk init -r git@github.com:yourusername/dotfiles.git
lnk pull  # auto-creates symlinks

Technical Advantages

Minimal Complexity: Lnk focuses on usability and straightforward implementation without the bells and whistles that add complexity.
Efficient and Portable: The tool includes relative symlinks and adheres to XDG standards, ensuring compatibility across different environments.
Atomic Operations: Operations are designed to permit rollback on failure, safeguarding your files during changes.

Alternatives

Lnk distinguishes itself in a landscape of dotfile management tools by offering a minimalistic approach:

Tool	Complexity	Description
lnk	Minimal	Simple and effective Git-native model.
chezmoi	High	Feature-rich with advanced templating.
yadm	Medium	For Git power users needing encryption.
dotbot	Low	Basic YAML configuration.
stow	Low	Perl-based for simple symlink operations.

Lnk is suitable for everyday use, providing robust features while remaining accessible and efficient for anyone looking to manage dotfiles effectively.