https://github.com/pa/dotman
dotman is a go based simple and light weight tool for managing dotfiles
https://github.com/pa/dotman
dotfiles-manager dotman
Last synced: about 1 year ago
JSON representation
dotman is a go based simple and light weight tool for managing dotfiles
- Host: GitHub
- URL: https://github.com/pa/dotman
- Owner: pa
- License: mit
- Created: 2021-12-24T15:42:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-07T09:59:22.000Z (over 4 years ago)
- Last Synced: 2024-06-20T14:15:11.048Z (almost 2 years ago)
- Topics: dotfiles-manager, dotman
- Language: Go
- Homepage:
- Size: 74.7 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dotman - dot(files) man(ager)
dotman is a [go](https://go.dev/) based simple and light weight tool for managing [dotfiles](https://en.wikipedia.org/wiki/Hidden_file_and_hidden_directory). This tool uses a [bare Git repository](https://www.atlassian.com/git/tutorials/dotfiles) that means your `$HOME` will be your git work tree. Also, it offers a plugin manager with rules to copy files from source git repo and even directory which most of the tools out there wouldn't support.
I had been inspired by [Bhupesh's](https://github.com/Bhupesh-V) project [dotman](https://github.com/Bhupesh-V/dotman) after which I have named this tool.
## Requirements
- [Git](https://git-scm.com/) executable insatlled on your machine
- A Git repo, where you version control your dotfiles. Create one from [here](https://github.com/new) if you want.
## Installation
### via Go
```bash
go install github.com/pa/dotman@latest
# you can also install specific verison instead of latest
```
### via Binary
Go to the [release page](https://github.com/pa/dotman/releases), find the version you want and download the archive. Unpack it and put the binary to somewhere you want (on UNIX-y systems, /usr/local/bin or the like). Make sure to turn on the executable bits if you are using custom location.
## Demo
A quick demo of the tool,
https://user-images.githubusercontent.com/44371915/149934976-4dda052b-81b3-42ad-9ad7-e406c4a3af66.mov
## Configuration File
Create a config file named `.dotman-config.` under your `$HOME` directory. The dotman supports various config file formats JSON, TOML and YAML.
.dotman-config.yaml
```yaml
autoCommit:
externals:
:
- url:
paths:
- # can be either directory or file
# soure path - directory or file path from git repo dir
# target path - target directory or file path
```
below is a example of dotman config
```yaml
autoCommit: true
externals:
.config/fish:
- url: https://github.com/IlanCosman/tide
paths:
- completions completions
- conf.d conf.d
- functions functions
- url: https://github.com/jethrokuan/z
paths:
- conf.d conf.d
- functions functions
.vim/pack/plugins/start:
- url: https://github.com/preservim/nerdtree.git
```
## Usage
```
Usage:
dotman [command]
Available Commands:
add Add file contents to the index
commit Record changes to the repository
completion Generate completion script
config Set and read git configuration variables
diff Show changes between commits, commit and working tree, etc
help Help about any command
init Clones dotfiles repo from remote git repository
pull Fetch from and merge with another repository or a local branch
push Update remote refs along with associated objects
reset Reset current HEAD to the specified state
stash Stash away changes
status Show the working tree status
update-externals Downloads and updates git externals like plugins, etc
```
### Generate completion script
you can generate completion script by using below command.
```bash
dotman completion [bash|zsh|fish]
```
## Example
```bash
# dotman init
❯ dotman init
Using config file: /Users/pa/.dotman-config.yaml
git repo url
# dotman add
❯ dotman add ~/.zshrc
Using config file: /Users/pa/.dotman-config.yaml
# dotman status
❯ dotman status
Using config file: /Users/pa/.dotman-config.yaml
On branch main
Changes to be committed:
(use "git restore --staged ..." to unstage)
new file: ../../../.zshrc
Changes not staged for commit:
(use "git add ..." to update what will be committed)
(use "git restore ..." to discard changes in working directory)
modified: ../../../.config/fish/config.fish
Untracked files not listed (use -u option to show untracked files)
# dotman push
❯ dotman push -u origin
# dotman update-externals
❯ dotman update-externals
Using config file: /Users/pa/.dotman-config.yaml
Cloning into '/Users/pa/.dotman/externals/tide'...
remote: Enumerating objects: 6661, done.
remote: Counting objects: 100% (866/866), done.
remote: Compressing objects: 100% (173/173), done.
remote: Total 6661 (delta 778), reused 713 (delta 688), pack-reused 5795
Receiving objects: 100% (6661/6661), 6.16 MiB | 3.22 MiB/s, done.
Resolving deltas: 100% (4257/4257), done.
Cloning into '/Users/pa/.dotman/externals/z'...
remote: Enumerating objects: 582, done.
remote: Counting objects: 100% (112/112), done.
remote: Compressing objects: 100% (68/68), done.
remote: Total 582 (delta 57), reused 65 (delta 30), pack-reused 470
Receiving objects: 100% (582/582), 92.20 KiB | 1.74 MiB/s, done.
Resolving deltas: 100% (313/313), done.
```
## Tips
If you want to use README in your dotfiles repo and don't want to store it in `$HOME` directly, then go ahead and create a `README.md` file under directory `.github` in your `$HOME` path.
## TODO
- Add more git native commands
- Write unit tests
- Add GitHub action to build and test
- Release package to various distributions
- Add support for Windows