https://github.com/magcho/dotz

Manage dotfiles for macOS
https://github.com/magcho/dotz

backup dotfiles-manager macos

Last synced: 3 months ago
JSON representation

Manage dotfiles for macOS

• Host: GitHub
• URL: https://github.com/magcho/dotz
• Owner: magcho
• License: apache-2.0
• Created: 2019-08-31T15:00:15.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T08:41:31.000Z (over 2 years ago)
• Last Synced: 2026-03-02T02:29:56.847Z (4 months ago)
• Topics: backup, dotfiles-manager, macos
• Language: Go
• Homepage:
• Size: 2.51 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  





Manage dotfiles for macOS  



![build for mac](https://github.com/magcho/dotz/workflows/build%20for%20mac/badge.svg)

## install

### Useing homebrew

```

brew tap magcho/magcho

brew install dotz

```

### Manually

Download dotz binary from [Github relase](https://github.com/magcho/dotz/releases),and move directory into $PATH.

### Self build

Cloning this repository. Exec `go build main.go -o dotz` and move directory into $PATH.

## Usage

### Init

  Before setting $DOTZ_ROOT or command parameter.

  ```

  export DOTZ_ROOT=~/.dotz

  dotz init

  ```

  

  1. Create dotz project folder into DOTZ_ROOT (default `~/.dotz`)

  1. Initialize git

### Track

  ```

  dotz track xx    // Tracking file

  dotz track -f xx // Tracking folder

  ```

  1. Move xx to dotz project folder.

  1. Create xx file or folder symbolic link.

  

### Backup

  Before setting dotz root git, dotz do backup.

  ```

  dotz backup [-p]

  ```

  1. Commit of dotzproject of git, optionally push.

  

---

### Restore

  Before cloning dotz project into $DOTZ_ROOT path and set env ＄DOTZ_ROOT.

  ```

  dotz restore

  ```

  1. Create symbolic links.

  

  

## Lisense

Apache License 2.0