Here’s the updated README.md with the new usage instructions (including the init command) and the installation options using curl and wget.

---

dot

A robust CLI tool to manage, install, and synchronize your dotfiles across multiple systems. The tool supports various Linux distributions (Debian, Ubuntu, Fedora, Arch) and macOS, ensuring your development environment is consistent everywhere.

---

Features

• Cross-Platform Compatibility: Works seamlessly on Linux (Debian, Ubuntu, Fedora, Arch) and macOS.
• Tool Installation: Automatically installs required tools like git, zsh, neovim, etc., based on your configuration.
• Dotfiles Synchronization:
  • Clones your dotfiles repository.
  • Manages symlinks using GNU Stow.
  • Pulls and pushes updates to your dotfiles repository with meaningful commit messages.
• Repository Initialization:
  • Quickly set up a new dotfiles repository with a basic structure and optional remote origin.
• Customizable:
  • Configure tools, dotfiles repository, and installation preferences using config.yml.
• Extensible CLI: Built with Cobra, offering modular commands with flags.

---

Installation

Prerequisites

Ensure the following are installed on your system:

• Git: For cloning your dotfiles repository.
• GNU Stow: For managing symlinks.

Install with curl or wget

Using curl:

curl -L https://github.com/fwartner/dot/releases/latest/download/dotfiles-$(uname -s)-$(uname -m) -o /usr/local/bin/dot
chmod +x /usr/local/bin/dot

Using wget:

wget https://github.com/fwartner/dot/releases/latest/download/dotfiles-$(uname -s)-$(uname -m) -O /usr/local/bin/dot
chmod +x /usr/local/bin/dot

The $(uname -s) and $(uname -m) dynamically resolve the operating system (Linux, Darwin) and architecture (x86_64, arm64), ensuring the correct binary is downloaded.

---

Build from Source

1. Clone the Repository

   git clone https://github.com/fwartner/dot.git
   cd dot

2. Initialize go.mod

   If go.mod does not exist (e.g., for fresh forks), initialize it:

   go mod init github.com/fwartner/dot
   go mod tidy

3. Build the Binary

   go build -o dotfiles

4. Install Locally

   Place the binary in your $PATH for easier usage:

   mv dotfiles /usr/local/bin/dot

---

Configuration

Create a config.yml file in one of the following locations:

• ./config.yml (current directory)
• ~/.config/dotfiles/config.yml
• ~/.dotfiles-config.yml

Example configuration:

# Repository URL for your dotfiles
dotfiles_repo: "https://github.com/fwartner/dotfiles-arch.git"

# Directory where the dotfiles will be cloned
dotfiles_dir: "~/dotfiles"

# List of tools to install
tools:
  - git
  - stow
  - zsh
  - neovim
  - tmux

---

Usage

The tool provides several commands to manage your dotfiles. Each command supports additional flags for customization.

1. Initialize a New Repository

dot init [--remote <repository-url>]

• Sets up a new directory for managing dotfiles.
• Initializes a Git repository in the directory.
• Optionally adds a remote origin if --remote is provided.

Example:

dot init --remote https://github.com/username/dotfiles.git

---

2. Install Dependencies

dot install [--skip <tool1,tool2>]

• Installs tools specified in config.yml.
• Skips installing tools listed with the --skip flag.

Example:

dot install --skip zsh,neovim

---

3. Setup Dotfiles

dot setup

• Clones the dotfiles repository.
• Manages symlinks using GNU Stow.

---

4. Pull Updates

dot pull

• Pulls the latest changes from your dotfiles repository.

---

5. Push Changes

dot push

• Pushes local changes to the dotfiles repository.
• Generates meaningful commit messages based on file changes, such as:
  • "Added: .zshrc, .vimrc; Modified: .bashrc; Deleted: .oldconfig"

---

Development

Prerequisites

• Go: Version 1.19 or later.

Project Structure

dot/
├── cmd/            # Command implementations
│   ├── init.go
│   ├── install.go
│   ├── setup.go
│   ├── pull.go
│   ├── push.go
├── utils/          # Reusable utilities
│   └── utils.go
├── main.go         # Entry point
├── config.yml      # Configuration file

Run Locally

go run main.go <command>

---

Contributing

Contributions are welcome! Feel free to fork the project and submit a pull request.

1. Fork the repository.
2. Create a new feature branch:

   git checkout -b feature/new-feature

3. Commit your changes:

   git commit -m "Add new feature"

4. Push to the branch:

   git push origin feature/new-feature

5. Open a pull request.

---

License

This project is licensed under the MIT License. See the LICENSE file for details.

---

Acknowledgements

• Cobra CLI Library
• GNU Stow
• Oh My Zsh