nedots

sourcehut | github

A smart, safe and intuitive dotfiles management tool.

Run nedots help / nedots --help / nedots for documentation.

If you'd like to see it in action, you can check out a build. The builds run with the maximum level of verbosity, so everything it does is logged to stdout. The builds showcase all of the functionality - it's not the most tangible "demo", but it does give you a peek at what it does.

.nedots.yml

When you use nedots, you maintain a small file that contains the address of your remote git repository, a list of directories or files, and a list of git submodules.

| Field | Type | Description | | :--------- | :-------------- | :------------------------------------------------------------------------------------------------------------------ | | root | String | The root directory. Dotfiles are stored here, as well as backups. | | dotsdir | String | This directory is appended to root if relative. Dotfiles are stored here. | | backupdir | String | This directory is also appended to root if relative. Backups are stored here. | | remote | String | The remote git repository address. https:// or ssh (git@) work, but ssh (read/write) should be preferred. | | sources | List<String> | A list of directories or files that nedots will manage. | | git_repos | List<GitRepo> | A list of GitRepo, see GitRepo model below. |

GitRepo

| Field | Type | Description | | :----- | :------- | :---------------------------------------------------------------------------------------------------------- | | id | String | An identifier for this GitRepo. nedots install {id} may be used to only install this particular source. | | remote | String | Remote git repository. | | path | String | Local path of GitRepo, relative to $HOME. |

Here is a small example:

yml root: .nedots dots_dir: dots backup_dir: backups remote: git@git.sr.ht:~nedia/nedots sources: - .config/bspwm - .profile - /etc/hostname - Wallpapers git_repos: - repo: id: nvim remote: git@git.sr.ht:~nedia/config.nvim path: .config/nvim

sources

Operations such as install will copy these files from {root}/{dots_dir}/{source} to $HOME/{source}.

Conversely, gather will copy files from $HOME/{source} to {root}/{dots_dir}/{source}.

Directories will be copied recursively. Paths can be owned by you, or another, but the correct permissions will be required at runtime to perform operations on paths that are not owned by you - you will need to run sudo nedots to install or gather files in /etc/ for example.

Usage

So you're new to this style of storing your dotfiles but the chances are you've got a git repository for storing your dotfiles. That's some of the work done already.

```sh

To set nedots up in its default location $HOME/.nedots

nedots init

Or to choose your own location

nedots --root $HOME/.dotfiles init

NOTE: Subsequent calls to nedots will need to be passed --root $HOME/.dotfiles

or --cfgpath $HOME/.dotfiles/.nedots.yml.

```

Next, you'll need to edit .nedots.yml - sources specifically, so that nedots sync can collect your files. It'll then copy them to $HOME/.nedots/dots.

```sh

Recommend adding --nopush so nedots won't push these changes to remote.

You can review them first.

Gather is responsible for collecting your files.

nedots sync --gather --nopush

Or to sync to a different directory

nedots --root $HOME/.dotfiles --dots