https://github.com/mamoruds/dotfiles
Configuration files for git, neovim, tmux and zsh.
https://github.com/mamoruds/dotfiles
dotfiles
Last synced: 3 months ago
JSON representation
Configuration files for git, neovim, tmux and zsh.
- Host: GitHub
- URL: https://github.com/mamoruds/dotfiles
- Owner: MamoruDS
- License: mit
- Created: 2023-01-10T08:14:28.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-28T12:56:08.000Z (about 1 year ago)
- Last Synced: 2025-05-28T13:41:29.616Z (about 1 year ago)
- Topics: dotfiles
- Language: Shell
- Homepage:
- Size: 289 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dotfiles
## Install
This repository using [dotter](https://github.com/SuperCuber/dotter#installation) to manage dotfiles.
- Install dotter:
```shell
cargo install dotter
```
or install from github [release](https://github.com/SuperCuber/dotter/releases)
- Clone this repository to any directory:
```shell
git clone --recursive git@github.com:MamoruDS/dotfiles.git
```
- Deploy with dotter:
[config](https://github.com/SuperCuber/dotter/wiki/Setup-and-Configuration) your local file in `.dotter/local.toml`
```toml
# an example of local.toml
# valid packages and variables can be found in .dotter/global.toml
packages = ["zsh", "tmux"]
[files]
zshrc = "~/.zshrc.dot"
[variables]
use_nerdfont = 1 # if you have nerdfont installed
zsh_plugin_autosuggestions = 1
```
and using `dotter` to deploy dotfiles.
```
cd dotfiles
dotter -v
```
### Requirements
- [fzf](https://github.com/junegunn/fzf#installation) or [skim](https://github.com/lotabout/skim) is required for using `zsh`'s plugin [zsh-history-fuzzy-search](https://github.com/MamoruDS/zsh-history-fuzzy-search)
- [fzf](https://github.com/junegunn/fzf#installation)
is required for using `zsh`'s plugin [fzf-tab](https://github.com/Aloxaf/fzf-tab)
- [file](https://www.darwinsys.com/file/)
for using preview utils in [fzf-tab](https://github.com/Aloxaf/fzf-tab)
- [tpm](https://github.com/tmux-plugins/tpm) is required for using package `tmux` with plugins (disabled by default)
```shell
git clone https://github.com/tmux-plugins/tpm ~/.tmux/plugins/tpm
```
and enable plugins for `tmux` package in your dotter local config
```toml
# in your local.toml
[variables]
tmux_using_plugins = 1
```
## Usage
If you have installed the dotfiles with package `zsh`, you can easily keep your dotfiles up-to-date using the update-dotfiles function. This function searches for the root of your dotfiles repository at `~/.dotfiles`, and looks for the local config toml file at `~/.dotfiles/.dotter/local.toml`. However, you can customize these locations using environment variables specific to your setup, as follows:
```shell
# specific path of your dotter binary; default: dotter
DOTTER_BIN=~/bin/dotter
# root of dotfiles repo; default: ~/.dotfiles
DOTFILES_ROOT=~/dotfiles
# location of the local config; default: $DOTFILES_ROOT/.dotter/local.toml
DOTFILES_LOCAL=~/.dot.local.toml
# update dotfiles without pull from remote; default:
DOTFILES_IGNORE_REMOTE=1
```
To use the update function, simply run it from your shell:
```shell
update-dotfiles
# or with force; equivalent dotter -f
update-dotfiles -f
```