Skip to content

Commit

Permalink
docs: document dotfiles (#44)
Browse files Browse the repository at this point in the history
Add dotfiles to configuration options page
  • Loading branch information
ardrigh authored Mar 12, 2024
1 parent 5a06775 commit ccf727b
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions src/content/docs/configuration/config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -450,3 +450,35 @@ common_prefix = [
```

Configures commands that should be totally stripped from stats calculations. For example, 'sudo' should be ignored.

### `dotfiles`
Atuin version: >= 18.1

Default: false

To enable sync of shell aliases between hosts. Requires `sync` enabled.

Add the new section to the bottom of your config file, for every machine you use Atuin with

```
[sync]
records = true

[dotfiles]
enabled = true
```

Manage aliases using the command line options

```
# Alias 'k' to 'kubectl'
atuin dotfiles alias create k kubectl

# List all aliases
atuin dotfiles alias list

# Delete an alias
atuin dotfiles alias delete k
```

After setting an alias, you will either need to restart your shell or source the init file for the change to take affect

0 comments on commit ccf727b

Please sign in to comment.