Syncing dotfiles

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

At the moment, Atuin supports managing and syncing of shell aliases and environment variables - with more coming soon.

Dotfiles syncing is available on zsh, bash, fish, xonsh, and PowerShell. See Supported platforms for the full support matrix.

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

Required config

Once Atuin is set up 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.

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

Delete an alias with:

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

Env vars

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

Creating a var

atuin dotfiles var set NAME 'value'

For example, to set FOO to be bar

atuin dotfiles var set FOO 'bar'

Vars are exported by default, but you can create a shell var like so

atuin dotfiles var set -n foo 'bar'

Deleting a var

Delete a var with:

atuin dotfiles var delete NAME

For example, to delete the above var FOO:

atuin dotfiles var delete FOO

Listing vars

You can list all vars with:

atuin dotfiles var list

Syncing and backing up dotfiles

If you have set up sync, then running

atuin sync

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