Skip to content
Atuin Docs

Syncing dotfiles

While Atuin started as a tool for syncing and searching shell history, we are building tooling for syncing dotfiles across machines, and making them easier to work with.

At the moment, we only support managing and syncing shell aliases - with more coming soon.

The following shells are supported:

  • zsh
  • bash
  • fish
  • xonsh

Note: Atuin handles your configuration internally, so once it is installed you no longer need to edit your config files manually.

Required config

Once Atuin is setup and installed, the following is required in your config file (~/.config/atuin/config.toml)

[dotfiles]
enabled = true

In a later release, this will be enabled by default.

Note: If you have not yet setup sync v2, please also add

[sync]
records = true

to the same config file.

Usage

Aliases

After creating or deleting an alias, remember to restart your shell!

Creating an alias

atuin dotfiles alias set NAME 'COMMAND'

For example, to alias k to be kubectl

atuin dotfiles alias set k 'kubectl'

or to alias ll to be ls -lah

atuin dotfiles alias set ll 'ls -lah'

Deleting an alias

Deleting an alias is as simple as:

atuin dotfiles alias delete NAME

For example, to delete the above alias k:

atuin dotfiles alias delete k

Listing aliases

You can list all aliases with:

atuin dotfiles alias list

Syncing and backing up aliases

If you have setup sync, then running

atuin sync

will backup your config to the server and sync it across machines.