mirror of
https://github.com/atuinsh/atuin.git
synced 2024-11-23 00:34:20 +01:00
88f3e2a04f
* make enter execute the command, tab copy it * Add config for enter_accept enter_accept will make Atuin immediately accept an execute a command when selected. It defaults to false in our binary, but the default config enables it. This means that users who already use atuin will not default to the new behaviour unless they opt in, but new users will have it by default. Thanks to @davidhewitt for the patch and bulk of this implementation! Currently we have it just for zsh, but I'll follow up with other shells (unless anyone beats me to it :D) * Add docs * we need to tidy up the ui code anyway * Check if using zsh * Update docs/docs/config/config.md Co-authored-by: Conrad Ludgate <conradludgate@gmail.com> --------- Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com> Co-authored-by: Conrad Ludgate <conradludgate@gmail.com>
130 lines
4.6 KiB
TOML
130 lines
4.6 KiB
TOML
## where to store your database, default is your system data directory
|
|
## linux/mac: ~/.local/share/atuin/history.db
|
|
## windows: %USERPROFILE%/.local/share/atuin/history.db
|
|
# db_path = "~/.history.db"
|
|
|
|
## where to store your encryption key, default is your system data directory
|
|
## linux/mac: ~/.local/share/atuin/key
|
|
## windows: %USERPROFILE%/.local/share/atuin/key
|
|
# key_path = "~/.key"
|
|
|
|
## where to store your auth session token, default is your system data directory
|
|
## linux/mac: ~/.local/share/atuin/session
|
|
## windows: %USERPROFILE%/.local/share/atuin/session
|
|
# session_path = "~/.session"
|
|
|
|
## date format used, either "us" or "uk"
|
|
# dialect = "us"
|
|
|
|
## enable or disable automatic sync
|
|
# auto_sync = true
|
|
|
|
## enable or disable automatic update checks
|
|
# update_check = true
|
|
|
|
## address of the sync server
|
|
# sync_address = "https://api.atuin.sh"
|
|
|
|
## how often to sync history. note that this is only triggered when a command
|
|
## is ran, so sync intervals may well be longer
|
|
## set it to 0 to sync after every command
|
|
# sync_frequency = "10m"
|
|
|
|
## which search mode to use
|
|
## possible values: prefix, fulltext, fuzzy, skim
|
|
# search_mode = "fuzzy"
|
|
|
|
## which filter mode to use
|
|
## possible values: global, host, session, directory
|
|
# filter_mode = "global"
|
|
|
|
## With workspace filtering enabled, Atuin will filter for commands executed
|
|
## in any directory within a git repositiry tree (default: false)
|
|
# workspaces = false
|
|
|
|
## which filter mode to use when atuin is invoked from a shell up-key binding
|
|
## the accepted values are identical to those of "filter_mode"
|
|
## leave unspecified to use same mode set in "filter_mode"
|
|
# filter_mode_shell_up_key_binding = "global"
|
|
|
|
## which search mode to use when atuin is invoked from a shell up-key binding
|
|
## the accepted values are identical to those of "search_mode"
|
|
## leave unspecified to use same mode set in "search_mode"
|
|
# search_mode_shell_up_key_binding = "fuzzy"
|
|
|
|
## which style to use
|
|
## possible values: auto, full, compact
|
|
# style = "auto"
|
|
|
|
## the maximum number of lines the interface should take up
|
|
## set it to 0 to always go full screen
|
|
# inline_height = 0
|
|
|
|
##Invert the UI - put the search bar at the top , Default to `false`
|
|
# invert = false
|
|
|
|
## enable or disable showing a preview of the selected command
|
|
## useful when the command is longer than the terminal width and is cut off
|
|
# show_preview = false
|
|
|
|
## what to do when the escape key is pressed when searching
|
|
## possible values: return-original, return-query
|
|
# exit_mode = "return-original"
|
|
|
|
## possible values: emacs, subl
|
|
# word_jump_mode = "emacs"
|
|
|
|
## characters that count as a part of a word
|
|
# word_chars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
|
|
|
|
## number of context lines to show when scrolling by pages
|
|
# scroll_context_lines = 1
|
|
|
|
## use ctrl instead of alt as the shortcut modifier key for numerical UI shortcuts
|
|
## alt-0 .. alt-9
|
|
# ctrl_n_shortcuts = false
|
|
|
|
## prevent commands matching any of these regexes from being written to history.
|
|
## Note that these regular expressions are unanchored, i.e. if they don't start
|
|
## with ^ or end with $, they'll match anywhere in the command.
|
|
## For details on the supported regular expression syntax, see
|
|
## https://docs.rs/regex/latest/regex/#syntax
|
|
# history_filter = [
|
|
# "^secret-cmd",
|
|
# "^innocuous-cmd .*--secret=.+"
|
|
# ]
|
|
|
|
## prevent commands run with cwd matching any of these regexes from being written
|
|
## to history. Note that these regular expressions are unanchored, i.e. if they don't
|
|
## start with ^ or end with $, they'll match anywhere in CWD.
|
|
## For details on the supported regular expression syntax, see
|
|
## https://docs.rs/regex/latest/regex/#syntax
|
|
# cwd_filter = [
|
|
# "^/very/secret/area"
|
|
# ]
|
|
|
|
## Configure the maximum height of the preview to show.
|
|
## Useful when you have long scripts in your history that you want to distinguish
|
|
## by more than the first few lines.
|
|
# max_preview_height = 4
|
|
|
|
## Configure whether or not to show the help row, which includes the current Atuin
|
|
## version (and whether an update is available), a keymap hint, and the total
|
|
## amount of commands in your history.
|
|
# show_help = true
|
|
|
|
## Invert the UI - put the search bar at the top
|
|
# invert = false
|
|
|
|
## Defaults to true. This matches history against a set of default regex, and will not save it if we get a match. Defaults include
|
|
## 1. AWS key id
|
|
## 2. Github pat (old and new)
|
|
## 3. Slack oauth tokens (bot, user)
|
|
## 4. Slack webhooks
|
|
## 5. Stripe live/test keys
|
|
# secrets_filter = true
|
|
|
|
## Defaults to true. If enabled, upon hitting enter Atuin will immediately execute the command. Press tab to return to the shell and edit.
|
|
# This applies for new installs. Old installs will keep the old behaviour unless configured otherwise.
|
|
enter_accept = true
|