|
| 1 | +## where to store your database, default is your system data directory |
| 2 | +## linux/mac: ~/.local/share/atuin/history.db |
| 3 | +## windows: %USERPROFILE%/.local/share/atuin/history.db |
| 4 | +# db_path = "~/.history.db" |
| 5 | + |
| 6 | +## where to store your encryption key, default is your system data directory |
| 7 | +## linux/mac: ~/.local/share/atuin/key |
| 8 | +## windows: %USERPROFILE%/.local/share/atuin/key |
| 9 | +# key_path = "~/.key" |
| 10 | + |
| 11 | +## where to store your auth session token, default is your system data directory |
| 12 | +## linux/mac: ~/.local/share/atuin/session |
| 13 | +## windows: %USERPROFILE%/.local/share/atuin/session |
| 14 | +# session_path = "~/.session" |
| 15 | + |
| 16 | +## date format used, either "us" or "uk" |
| 17 | +# dialect = "us" |
| 18 | + |
| 19 | +## default timezone to use when displaying time |
| 20 | +## either "l", "local" to use the system's current local timezone, or an offset |
| 21 | +## from UTC in the format of "<+|->H[H][:M[M][:S[S]]]" |
| 22 | +## for example: "+9", "-05", "+03:30", "-01:23:45", etc. |
| 23 | +# timezone = "local" |
| 24 | + |
| 25 | +## enable or disable automatic sync |
| 26 | +# auto_sync = true |
| 27 | + |
| 28 | +## enable or disable automatic update checks |
| 29 | +# update_check = true |
| 30 | + |
| 31 | +## address of the sync server |
| 32 | +# sync_address = "https://api.atuin.sh" |
| 33 | + |
| 34 | +## how often to sync history. note that this is only triggered when a command |
| 35 | +## is ran, so sync intervals may well be longer |
| 36 | +## set it to 0 to sync after every command |
| 37 | +# sync_frequency = "10m" |
| 38 | + |
| 39 | +## which search mode to use |
| 40 | +## possible values: prefix, fulltext, fuzzy, skim |
| 41 | +# search_mode = "fuzzy" |
| 42 | + |
| 43 | +## which filter mode to use |
| 44 | +## possible values: global, host, session, directory |
| 45 | +# filter_mode = "global" |
| 46 | + |
| 47 | +## With workspace filtering enabled, Atuin will filter for commands executed |
| 48 | +## in any directory within a git repository tree (default: false) |
| 49 | +# workspaces = false |
| 50 | + |
| 51 | +## which filter mode to use when atuin is invoked from a shell up-key binding |
| 52 | +## the accepted values are identical to those of "filter_mode" |
| 53 | +## leave unspecified to use same mode set in "filter_mode" |
| 54 | +# filter_mode_shell_up_key_binding = "global" |
| 55 | + |
| 56 | +## which search mode to use when atuin is invoked from a shell up-key binding |
| 57 | +## the accepted values are identical to those of "search_mode" |
| 58 | +## leave unspecified to use same mode set in "search_mode" |
| 59 | +# search_mode_shell_up_key_binding = "fuzzy" |
| 60 | + |
| 61 | +## which style to use |
| 62 | +## possible values: auto, full, compact |
| 63 | +style = "compact" |
| 64 | + |
| 65 | +## the maximum number of lines the interface should take up |
| 66 | +## set it to 0 to always go full screen |
| 67 | +# inline_height = 0 |
| 68 | + |
| 69 | +## Invert the UI - put the search bar at the top , Default to `false` |
| 70 | +# invert = false |
| 71 | + |
| 72 | +## enable or disable showing a preview of the selected command |
| 73 | +## useful when the command is longer than the terminal width and is cut off |
| 74 | +# show_preview = false |
| 75 | + |
| 76 | +## what to do when the escape key is pressed when searching |
| 77 | +## possible values: return-original, return-query |
| 78 | +# exit_mode = "return-original" |
| 79 | + |
| 80 | +## possible values: emacs, subl |
| 81 | +# word_jump_mode = "emacs" |
| 82 | + |
| 83 | +## characters that count as a part of a word |
| 84 | +# word_chars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789" |
| 85 | + |
| 86 | +## number of context lines to show when scrolling by pages |
| 87 | +# scroll_context_lines = 1 |
| 88 | + |
| 89 | +## use ctrl instead of alt as the shortcut modifier key for numerical UI shortcuts |
| 90 | +## alt-0 .. alt-9 |
| 91 | +# ctrl_n_shortcuts = false |
| 92 | + |
| 93 | +## default history list format - can also be specified with the --format arg |
| 94 | +# history_format = "{time}\t{command}\t{duration}" |
| 95 | + |
| 96 | +## prevent commands matching any of these regexes from being written to history. |
| 97 | +## Note that these regular expressions are unanchored, i.e. if they don't start |
| 98 | +## with ^ or end with $, they'll match anywhere in the command. |
| 99 | +## For details on the supported regular expression syntax, see |
| 100 | +## https://docs.rs/regex/latest/regex/#syntax |
| 101 | +# history_filter = [ |
| 102 | +# "^secret-cmd", |
| 103 | +# "^innocuous-cmd .*--secret=.+" |
| 104 | +# ] |
| 105 | + |
| 106 | +## prevent commands run with cwd matching any of these regexes from being written |
| 107 | +## to history. Note that these regular expressions are unanchored, i.e. if they don't |
| 108 | +## start with ^ or end with $, they'll match anywhere in CWD. |
| 109 | +## For details on the supported regular expression syntax, see |
| 110 | +## https://docs.rs/regex/latest/regex/#syntax |
| 111 | +# cwd_filter = [ |
| 112 | +# "^/very/secret/area" |
| 113 | +# ] |
| 114 | + |
| 115 | +## Configure the maximum height of the preview to show. |
| 116 | +## Useful when you have long scripts in your history that you want to distinguish |
| 117 | +## by more than the first few lines. |
| 118 | +# max_preview_height = 4 |
| 119 | + |
| 120 | +## Configure whether or not to show the help row, which includes the current Atuin |
| 121 | +## version (and whether an update is available), a keymap hint, and the total |
| 122 | +## amount of commands in your history. |
| 123 | +# show_help = true |
| 124 | + |
| 125 | +## Defaults to true. This matches history against a set of default regex, and will not save it if we get a match. Defaults include |
| 126 | +## 1. AWS key id |
| 127 | +## 2. Github pat (old and new) |
| 128 | +## 3. Slack oauth tokens (bot, user) |
| 129 | +## 4. Slack webhooks |
| 130 | +## 5. Stripe live/test keys |
| 131 | +# secrets_filter = true |
| 132 | + |
| 133 | +## Defaults to true. If enabled, upon hitting enter Atuin will immediately execute the command. Press tab to return to the shell and edit. |
| 134 | +# This applies for new installs. Old installs will keep the old behaviour unless configured otherwise. |
| 135 | +enter_accept = true |
| 136 | + |
| 137 | + |
| 138 | +## Defaults to "emacs". This specifies the keymap on the startup of `atuin |
| 139 | +## search`. If this is set to "auto", the startup keymap mode in the Atuin |
| 140 | +## search is automatically selected based on the shell's keymap where the |
| 141 | +## keybinding is defined. If this is set to "emacs", "vim-insert", or |
| 142 | +## "vim-normal", the startup keymap mode in the Atuin search is forced to be |
| 143 | +## the specified one. |
| 144 | +# keymap_mode = "auto" |
| 145 | + |
| 146 | +## Cursor style in each keymap mode. If specified, the cursor style is changed |
| 147 | +## in entering the cursor shape. Available values are "default" and |
| 148 | +## "{blink,steady}-{block,underilne,bar}". |
| 149 | +# keymap_cursor = { emacs = "blink-block", vim_insert = "blink-block", vim_normal = "steady-block" } |
| 150 | + |
| 151 | +# network_connect_timeout = 5 |
| 152 | +# network_timeout = 5 |
| 153 | + |
| 154 | +## Timeout (in seconds) for acquiring a local database connection (sqlite) |
| 155 | +# local_timeout = 5 |
| 156 | + |
| 157 | +## Set this to true and Atuin will minimize motion in the UI - timers will not update live, etc. |
| 158 | +## Alternatively, set env NO_MOTION=true |
| 159 | +# prefers_reduced_motion = false |
| 160 | + |
| 161 | +#[stats] |
| 162 | +# Set commands where we should consider the subcommand for statistics. Eg, kubectl get vs just kubectl |
| 163 | +#common_subcommands = [ |
| 164 | +# "cargo", |
| 165 | +# "go", |
| 166 | +# "git", |
| 167 | +# "npm", |
| 168 | +# "yarn", |
| 169 | +# "pnpm", |
| 170 | +# "kubectl", |
| 171 | +#] |
| 172 | +# |
| 173 | +# Set commands that should be totally stripped and ignored from stats |
| 174 | +#common_prefix = ["sudo"] |
0 commit comments