Skip to content

Configuration variables

TIP

Scroll the table horizontally

VariableAdded InType
Use
DefaultLimitations
ABBR_AUTOLOAD3.3.2integerIf non-zero, automatically account for updates to the user abbreviations file (read Storage and manual editing)1
ABBR_DEBUG3.2.0integerIf non-zero, print debugging messages0
ABBR_DEFAULT_BINDINGS2.0.0integerIf non-zero, add the default bindings (read Widgets and key bindings)1
ABBR_DRY_RUN3.2.0integerIf non-zero, use dry run mode without passing --dry-run0
ABBR_EXPAND_AND_ACCEPT_PUSH_ABBREVIATED_LINE_TO_HISTORY6.0.0integerIf non-zero, when abbr-expand-and-accept expands an abbreviation it adds one or two entries to the shell history, before the accepted line's history entry. If ABBR_EXPAND_PUSH_ABBREVIATION_TO_HISTORY is zero, one history entry is added: the line before it expanded. If ABBR_EXPAND_PUSH_ABBREVIATION_TO_HISTORY is non-zero the abbreviation is added to the shell history and, if there was more on the unexpanded line that just the abbreviation, the unexpanded line is added as a separate history entry.0Unaware of setopt hist_ignore_space and unsetopt hist_ignore_space run interactively after session initialization.
ABBR_EXPAND_PUSH_ABBREVIATION_TO_HISTORY6.0.0integerIf non-zero, when abbr-expand expands an abbreviation it also adds the abbreviation to the shell history0
ABBR_EXPANSION_CURSOR_MARKER5.4.0stringRead ABBR_SET_EXPANSION_CURSOR in this table$ABBR_LINE_CURSOR_MARKERCannot contain ^. Read issue #140.
ABBR_FORCE5.1.0integerIf non-zero, use force mode without passing --force (read Usage > Commands > add)0
ABBR_GET_AVAILABLE_ABBREVIATION6.0.0integerIf non-zero, check whether you could have used an abbreviation0
ABBR_LINE_CURSOR_MARKER5.4.0stringRead ABBR_SET_LINE_CURSOR in this table%
ABBR_LOG_AVAILABLE_ABBREVIATION6.0.0integerIf non-zero, log the abbreviation you could have used (you'll want to toggle ABBR_GET_AVAILABLE_ABBREVIATION on, too)0
ABBR_LOG_AVAILABLE_ABBREVIATION_AFTER6.0.0integerIf non-zero, ABBR_LOG_AVAILABLE_ABBREVIATION output is logged after the command output0
ABBR_QUIET4.0.0integerIf non-zero, use quiet mode without passing --quiet0
ABBR_QUIETER4.4.0integerIf non-zero, use quieter mode without passing --quieter0
ABBR_REGULAR_ABBREVIATION_GLOB_PREFIXES6.0.0arrayGlob prefixes. One or more prefixes can go in front of a regular abbreviation, and it will still expand.( ' ' )
ABBR_REGULAR_ABBREVIATION_SCALAR_PREFIXES6.0.0arrayScalar prefixes. One or more prefixes can go in front of a regular abbreviation, and it will still expand.( 'sudo ' )
ABBR_SET_EXPANSION_CURSOR5.4.0integerIf non-zero and the expansion includes ABBR_EXPANSION_CURSOR_MARKER, abbr-expand will replace the expansion's first instance of ABBR_EXPANSION_CURSOR_MARKER with the cursor, and abbr-expand-and-insert's bound key will not be inserted at the end of the expansion (read also Widgets and key bindings)0
ABBR_SET_LINE_CURSOR5.4.0integerIf non-zero and abbr-expand didn't place the cursor (because the ABBR_SET_EXPANSION_CURSOR is zero or the expansion did not include ABBR_EXPANSION_CURSOR_MARKER), abbr-expand-and-insert will replace the line's first instance of ABBR_LINE_CURSOR_MARKER with the cursor instead of inserting its bound key at the end of the expansion (read also Widgets and key bindings)0
ABBR_TMPDIR4.0.0StringPath to the directory temporary files are stored in.${${TMPDIR:-/tmp}%/}/zsh-abbr/ for users without privileges,
${${TMPDIR:-/tmp}%/}/zsh-abbr/ for users with privileges (e.g. su)

If changing this, you may want to delete the default directory.
As of v5.7.0, custom values for this variable do not have to end in /.
ABBR_USER_ABBREVIATIONS_FILE4.0.0StringPath to the file user abbreviation are stored in (read Storage and manual editing)${XDG_CONFIG_HOME:-$HOME/.config}/zsh-abbr/user-abbreviations

with legacy support for using ${XDG_CONFIG_HOME:-$HOME/.config}/zsh/abbreviations instead if a file exists at that path

If changing this, you may want to delete the default file.
NO_COLOR3.3.3mixedIf set (to any value or no value at all) abbr will not use color in its output. Learn more at https://no-color.org/.

Except where otherwise noted, © 2024 by Henry Bley-Vroman and licensed under zsh-abbr's license.