Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mbaraa/dotsync

Dotfiles synchronizer thingy
https://github.com/mbaraa/dotsync

cli dotfiles go linux synchronization

Last synced: about 2 months ago
JSON representation

Dotfiles synchronizer thingy

Awesome Lists containing this project

README

        

# Dotsync

[![GoDoc](https://godoc.org/github.com/mbaraa/dotsync?status.png)](https://godoc.org/github.com/mbaraa/dotsync)
.
[![build](https://github.com/mbaraa/dotsync/actions/workflows/build.yml/badge.svg)](https://github.com/mbaraa/dotsync/actions/workflows/build.yml)
.
[![Go Report Card](https://goreportcard.com/badge/github.com/mbaraa/dotsync)](https://goreportcard.com/report/github.com/mbaraa/dotsync)
.
[![server-rex-deploy](https://github.com/mbaraa/dotsync/actions/workflows/server-rex-deploy.yml/badge.svg)](https://github.com/mbaraa/dotsync/actions/workflows/server-rex-deploy.yml)
.
[![website-rex-deploy](https://github.com/mbaraa/dotsync/actions/workflows/website-rex-deploy.yml/badge.svg)](https://github.com/mbaraa/dotsync/actions/workflows/website-rex-deploy.yml)

A small, free, open-source, blazingly fast dotfiles synchronizer!

Dotsync's [server](/server) is the middleware between your connected computers, where all of your dotfiles stand there encrypted, and backed up!

## Features:

- Efficient
- Lightweight
- Blazingly Fast
- Cool Stack
- Open-source
- Free (of charge & evil data telemetry things)
- Self-hosting option, check [the server](/server)

## Dependencies:

- [go](https://golang.org)
- An internet connection
- Linux or Unix-like system (I haven't tried it on Windows, a feedback is more than welcome)
- A bunch of dotfiles to sync :)

## Installation:

### Using Go's installer

```bash
go install github.com/mbaraa/dotsync@latest

# or

make
sudo make install
```

## Usage:

### Create/Login using an email

And as mentioned above your email is encrypted, and won't be shared with anyone!

1. Login

```bash
dotsync -login [email protected]
```

2. Enter the token which you recived as an email(it might arrive as a spam email)

3. Go nuts

### Sync

1. Add and upload a bunch of files

```bash
# add a file
dotsync -add ~/.bashrc
dotsync -add ~/.config/i3/config
dotsync -add ~/.config/nvim/

# upload your current files
dotsync -upload
```

2. Download your files on another computer to show the power of Dotsync

```bash
# you need to login first, so...
dotsync -download
```

**For a more detailed usage, visit the [Officical Docs](https://dotsync.org/docs)**!