Top-level settings
data_dir
Section titled “data_dir”The directory that holds Atuin’s data. The other paths default to files in it.
- Type: string
- Default:
"~/.atuin/data"
dialect
Section titled “dialect”How atuin stats reads dates: us for month first, uk for day first.
- Type: string
- Default:
"us" - Values:
us,uk
timezone
Section titled “timezone”The time zone that times are shown in: local, utc, an offset from UTC such as +9:30,
or an IANA time zone name such as Europe/Berlin.
- Type: string
- Default:
"local"
The look of interactive search: compact, full, or auto, which picks compact when the
terminal is short.
- Type: string
- Default:
"compact" - Values:
auto,full,compact
auto_sync
Section titled “auto_sync”Sync automatically while logged in, every sync_frequency.
- Type: boolean
- Default:
true
update_check
Section titled “update_check”Check for a new release at most once an hour, and say so when one is out.
- Type: boolean
- Default:
true
update_channel
Section titled “update_channel”Which releases the update check reports: stable, or nightly for prereleases as well.
- Type: string
- Default:
"stable" - Values:
stable: Stable releases only.nightly: Prerelease builds, plus stable releases once they overtake the latest
sync_address
Section titled “sync_address”The server that Atuin syncs with. atuin setup --only --sync <URL> points it at your own
server.
- Type: string
- Default:
"https://api.atuin.sh/"
sync_protocol
Section titled “sync_protocol”Sync protocol for authentication. When set to “auto” (default), the protocol is inferred from sync_address. Set to “hub” to force Hub auth with a custom sync_address (useful for local development).
- Type: string
- Default:
"auto" - Values:
hub: Use Hub authentication (Bearer token from Hub OAuth flow)legacy: Use legacy CLI authentication (Token from CLI register/login)auto: Infer from sync_address (default behavior)
sync_frequency
Section titled “sync_frequency”How often to sync automatically, such as 5m. 0 syncs after every command.
- Type: string or number
- Default:
"5m"
db_path
Section titled “db_path”The history database.
- Type: string
- Default:
"~/.atuin/data/history.db"
record_store_path
Section titled “record_store_path”The record store, which holds what sync sends and receives.
- Type: string
- Default:
"~/.atuin/data/records.db"
key_path
Section titled “key_path”The key that sync encrypts your data with.
- Type: string
- Default:
"~/.atuin/data/key"
search_mode
Section titled “search_mode”How interactive search matches what you type: prefix, fulltext, fuzzy, or
daemon-fuzzy. atuin setup --only --daemon sets daemon-fuzzy as it turns the daemon on.
- Type: string
- Default:
"fuzzy" - Values:
prefix,fulltext,fuzzy,daemon-fuzzy
filter_mode
Section titled “filter_mode”The filter interactive search starts in. If unset, the first of search.filters.
- Type: string
- Default:
unset - Values:
global,host,session,directory,workspace,session-preload
filter_mode_shell_up_key_binding
Section titled “filter_mode_shell_up_key_binding”The filter search starts in when the up arrow opens it. If unset, filter_mode.
- Type: string
- Values:
global,host,session,directory,workspace,session-preload
search_mode_shell_up_key_binding
Section titled “search_mode_shell_up_key_binding”The search mode when the up arrow opens search. If unset, search_mode.
- Type: string
- Values:
prefix,fulltext,fuzzy,daemon-fuzzy
bind_ctrl_r
Section titled “bind_ctrl_r”Whether atuin init binds ctrl-r to search. atuin setup --only --no-ctrl-r turns it off,
and atuin init --disable-ctrl-r turns it off either way.
- Type: boolean
- Default:
true
bind_up_arrow
Section titled “bind_up_arrow”Whether atuin init binds the up arrow to search. atuin setup --only --no-up-arrow turns
it off, and atuin init --disable-up-arrow turns it off either way.
- Type: boolean
- Default:
true
inline_height
Section titled “inline_height”The most lines interactive search takes up. 0 uses the whole screen.
- Type: integer
- Default:
40
inline_height_shell_up_key_binding
Section titled “inline_height_shell_up_key_binding”The most lines search takes up when the up arrow opens it. If unset, inline_height.
- Type: integer
invert
Section titled “invert”Put the search bar at the top, with the results below it.
- Type: boolean
- Default:
false
show_preview
Section titled “show_preview”Show the selected command in full below the results.
- Type: boolean
- Default:
true
max_preview_height
Section titled “max_preview_height”The most lines the preview takes up.
- Type: integer
- Default:
4
show_help
Section titled “show_help”Show the help row: the version, a keymap hint, and how many commands your history holds.
- Type: boolean
- Default:
true
show_tabs
Section titled “show_tabs”Show the search and inspector tabs.
- Type: boolean
- Default:
true
show_whats_new
Section titled “show_whats_new”After an upgrade, show a short note about new features, once.
- Type: boolean
- Default:
true
show_numeric_shortcuts
Section titled “show_numeric_shortcuts”Show the 1 to 9 shortcuts beside the results.
- Type: boolean
- Default:
true
auto_hide_height
Section titled “auto_hide_height”Hide extra lines of the compact style below this many rows. 0 never hides them.
- Type: integer
- Default:
8
exit_mode
Section titled “exit_mode”What escape does: return-original leaves what you typed, return-query leaves the search
query. Ctrl-c and ctrl-d always leave what you typed.
- Type: string
- Default:
"return-original" - Values:
return-original,return-query
keymap_mode
Section titled “keymap_mode”The keymap search starts in: emacs, vim-normal, vim-insert, or auto, which follows
the shell’s mode.
Nushell doesn’t support auto, and starts search in emacs.
- Type: string
- Default:
"emacs" - Values:
emacs,vim-normal,vim-insert,auto
keymap_mode_shell
Section titled “keymap_mode_shell”The shell’s keymap, whose cursor style search restores on exit. auto leaves the cursor
as it is.
- Type: string
- Default:
"auto" - Values:
emacs,vim-normal,vim-insert,auto
keymap_cursor
Section titled “keymap_cursor”The cursor style in each keymap, such as { vim_insert = "blink-bar" }. The keymaps are
emacs, vim_insert and vim_normal.
- Type: table of string
- Default:
{} - Values:
default,blink-block,steady-block,blink-underline,steady-underline,blink-bar,steady-bar
word_jump_mode
Section titled “word_jump_mode”How word movement treats punctuation: emacs, or subl for Sublime Text’s rules.
- Type: string
- Default:
"emacs" - Values:
emacs,subl
word_chars
Section titled “word_chars”The characters word movement counts as part of a word, with word_jump_mode = "subl".
- Type: string
- Default:
"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
scroll_context_lines
Section titled “scroll_context_lines”How many results stay visible above or below the selection as it scrolls.
- Type: integer
- Default:
1
history_format
Section titled “history_format”The default format of atuin history list. --format overrides it.
- Type: string
- Default:
"{time}\t{command}\t{duration}"
strip_trailing_whitespace
Section titled “strip_trailing_whitespace”Trim whitespace from the end of a command before saving it.
- Type: boolean
- Default:
true
prefers_reduced_motion
Section titled “prefers_reduced_motion”Keep the interface still, without live-updating timestamps. Setting the NO_MOTION
environment variable turns it on too.
- Type: boolean
- Default:
false
store_failed
Section titled “store_failed”Save commands that exit with a non-zero status.
- Type: boolean
- Default:
true
no_mouse
Section titled “no_mouse”Leave the mouse to the terminal rather than using it in search.
- Type: boolean
- Default:
false
history_filter
Section titled “history_filter”Regular expressions of commands to keep out of your history, such as "^secret-cmd".
An expression matches anywhere in the command unless ^ or $ anchors it.
- Type: list of string
cwd_filter
Section titled “cwd_filter”Regular expressions of directories whose commands stay out of your history, such as
"^/very/secret/directory".
An expression matches anywhere in the path unless ^ or $ anchors it.
- Type: list of string
secrets_filter
Section titled “secrets_filter”Refuse to save commands that look like they hold a secret, such as an AWS key or a GitHub token.
The same patterns redact captured output and threads.
- Type: boolean
- Default:
true
workspaces
Section titled “workspaces”Add a workspace filter that searches the Git or Jujutsu repository you are in.
- Type: boolean
- Default:
true
ctrl_n_shortcuts
Section titled “ctrl_n_shortcuts”Use ctrl rather than alt with the number keys to pick a result. This helps on macOS,
where Option may type characters rather than act as alt.
- Type: boolean
- Default:
false
network_connect_timeout
Section titled “network_connect_timeout”How long to wait for a connection to the sync server, such as 5s.
- Type: string or number
- Default:
"5s"
network_timeout
Section titled “network_timeout”How long a request to the sync server may take before it fails, such as 30s.
- Type: string or number
- Default:
"30s"
local_timeout
Section titled “local_timeout”How long to wait for a connection to the local database, such as 2s.
- Type: string or number
- Default:
"2s"
extra_headers
Section titled “extra_headers”HTTP headers to send with every request to the sync server, such as those that Cloudflare Access asks for in front of a self-hosted server.
Headers that Atuin sets itself, such as Authorization, win over these. While any are set,
Atuin doesn’t follow a redirect to another origin.
- Type: table of string
- Default:
{}
enter_accept
Section titled “enter_accept”Run the selected command on enter, rather than putting it on the command line. Tab still puts it there.
The config file that a new install starts with sets it to true.
- Type: boolean
- Default:
false
smart_sort
Section titled “smart_sort”Rank results that start with the query above those that only contain it, newest first among equals.
- Type: boolean
- Default:
false
command_chaining
Section titled “command_chaining”After && or || on the command line, search for the next command and append it.
- Type: boolean
- Default:
false