https://github.com/vladmyr/dotfiles-plugin

Keep your dotfiles in sync using Git, a plugin for Oh My Zsh
https://github.com/vladmyr/dotfiles-plugin

dotfiles git oh-my-zsh plugin shell sync synchronization

Last synced: 27 days ago
JSON representation

Keep your dotfiles in sync using Git, a plugin for Oh My Zsh

• Host: GitHub
• URL: https://github.com/vladmyr/dotfiles-plugin
• Owner: vladmyr
• Created: 2018-11-21T21:36:57.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-11-25T19:00:28.000Z (about 5 years ago)
• Last Synced: 2024-06-20T05:49:28.650Z (6 months ago)
• Topics: dotfiles, git, oh-my-zsh, plugin, shell, sync, synchronization
• Language: Shell
• Homepage:
• Size: 4.88 KB
• Stars: 22
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Dotfiles Sync Plugin using Git  for Oh My Zsh

An Oh My Zsh plugin to keep your dotfines in sync across multiple PCs using Git.  

## Features

- Sets up Git repository in user's home directory to keep a track on whitelisted files & directories

- Provides simple CLI interface to commit, upload and download dotfiles from remote repository

## Installation

```

$ sh <(curl -sL https://raw.githubusercontent.com/vladmyr/dotfiles-plugin/master/install.sh) 

```

## Under the hood

Whole plugin is a tiny bash script wrapper around Git commands. An idea is to have a Git repository at user's home directory and whitelist only a specific files and directories to keep a track on. In order to achieve that plugin relies on a special file named `.gitinclude`. `.gitinclude` is used to achieve exactly the same behaviour as with `.gitignore`, except it contains a whitelist of all FS paths.

## Changelog

- 0.1.0

  - Basic set of CLI commands

  - Installation script

## License

MIT