A command-line tool to apply dotfiles from a Git repository to your current working directory.

dotme is a simple utility that helps you quickly set up your development environment by applying dotfiles from a Git repository. It only copies files and folders that start with a dot (.) from the root of the specified repository into your current directory.

• Apply dotfiles from any Git repository with a single command
• Only copies files and folders that start with a dot (.) at the repository root
• Recursively copies contents of dotfiles folders
• Cross-platform (Linux, macOS, Windows)
• Clear terminal output with information about what was copied and ignored
• Automatically cleans up temporary files after execution

Download the latest binary for your platform from the Releases page.

# Clone the repository
git clone https://github.com/rsvinicius/dotme.git

# Change to the project directory
cd dotme

# Build the binary
go build -o dotme

# Install the binary to your PATH (optional)
go install

# Apply dotfiles from a Git repository
dotme https://github.com/your-username/dotfiles

# Apply dotfiles from a repository
dotme https://github.com/your-username/dotfiles

This will:

1. Clone the repository to a temporary directory
2. Copy only files and folders that start with a dot (.) from the root of the repository to your current directory
3. Show what was copied and what was ignored
4. Clean up the temporary directory

dotme performs the following steps:

1. Clones the specified Git repository to a temporary directory
2. Scans the root of the cloned repository for files and folders that start with a dot (.)
3. Copies those files/folders to your current working directory
   • For folders, it recursively copies all contents (regardless of whether the inner files start with a dot)
4. Displays a summary of what was copied and what was ignored
5. Cleans up the temporary directory

Contributions are welcome! Please check out our Contributing Guidelines for details.

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

We use Semantic Versioning. For the versions available, see the tags on this repository.