https://github.com/wschella/punter
Simple dotfile manager
https://github.com/wschella/punter
configuration dotfiles dotfiles-manager ricing rust tool
Last synced: about 1 month ago
JSON representation
Simple dotfile manager
- Host: GitHub
- URL: https://github.com/wschella/punter
- Owner: wschella
- License: mpl-2.0
- Created: 2018-08-22T19:46:53.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-06-10T17:55:56.000Z (about 6 years ago)
- Last Synced: 2025-01-15T06:13:40.537Z (over 1 year ago)
- Topics: configuration, dotfiles, dotfiles-manager, ricing, rust, tool
- Language: Rust
- Size: 9.77 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# punter
Simple dotfile manager
## How to use
1. Get your dotfiles directory ready (e.g. by cloning it from git)
2. Generate the default config with `punter generate`
3. Make any changes you like to the generated `punter.toml`
4. Sync your dotfiles to your home directory with `punter sync`
You can add other dotfiles later with `punter add file`
### Config
By default `punter generate` will assume you want to symlink every file (and directory) in your dotfiles folder, and prefix it with a dot.
A default entry looks something like this `"bashrc" = ".bashrc"`
The default destination base is your home folder, but it can be specified.
Hidden files will not be added to your config automatically, you can add them yourself, or use the `--ignore-hidden` flag when generating. Another dot will of course _not_ be prefixed then.
An entry in a config is very flexible:
- the source can be any path relative to your dotfile folder
- the destination can be any path
- absolute destination paths will ignore the destination directory
You can update your config with `dotter add .`, which will ignore files already present.
#### Example config
```toml
[settings]
verbosity = "info"
destination = "/media/wschella/home"
[settings.sync]
link = "symlink"
[files]
"bashrc" = ".bashrc"
"absolute_file" = "/foo/bar"
".hidden_file" = ".absolute_file"
```
### Sync