Default parameters

Note that this document omits the initial :. To change the value of a default parameter, you can do something like this:

(param/set :root :default-frame "big-hex")

Values stored to :persist are never interpreted as default parameters and do not affect cy's behavior.

animate animate-delay animations color-error color-info color-map color-warn data-directory default-frame default-shell input-find-active-style input-find-highlight-style input-find-inactive-style input-preview-border input-preview-border-fg input-prompt-style input-thumbs-hint-style input-thumbs-match-style input-thumbs-partial-style num-search-workers remove-pane-on-exit replay-copy-style replay-incremental-style replay-match-active-style replay-match-inactive-style replay-play-style replay-selection-style replay-status-bar-style replay-text-copy-mode replay-text-play-mode replay-text-time-mode replay-text-visual-mode replay-time-style replay-visual-style search-status-bar-style search-text-no-matches-found search-text-searching terminal-text-exited timestamp-format use-system-clipboard

animate

Type: :boolean

Default: true

Whether to enable animation.

The delay (in seconds) before animations should begin. This is useful if you like cy's animations but find them distracting when working quickly. This only applies to the animations that play when using the (input/*) family of functions.

animations

Type: :array

Default: @[]

A list of all of the enabled animations that will be used by (input/find). If this is an empty array, all built-in animations will be enabled.

color-error

Type: :string

Default: "1"

The color used for error messages.

color-info

Type: :string

Default: "6"

The color used for info messages.

color-map

Type: :table

Default: @{}

The color map used to translate the colors used for rendering a pane.

color-warn

Type: :string

Default: "3"

The color used for warning messages.

data-directory

Type: :string

Default: ""

The directory in which .borg files will be saved. This is inferred on startup. If set to an empty string, recording to disk is disabled.

default-frame

Type: :string

Default: ""

The frame used for all new clients. A blank string means a random frame will be chosen from all frames.

default-shell

Type: :string

Default: "/bin/bash"

The default shell with which to start panes. Defaults to the value of $SHELL on startup.

input-find-active-style

Type: :table

Default: @{:bg "15" :fg "0"}

The style of the active row in (input/find).

input-find-highlight-style

Type: :table

Default: @{:bg "1" :fg "15"}

The style of highlighted characters in (input/find).

input-find-inactive-style

Type: :table

Default: @{:bg "7" :fg "0"}

The style of the inactive row in (input/find).

input-preview-border

Type: :keyword

Default: :normal

The border style of the preview border in (input/find).

input-preview-border-fg

Type: :string

Default: "5"

The color of the preview border in (input/find).

input-prompt-style

Type: :table

Default: @{:bg "3" :fg "0"}

The style of the input prompt in (input/*) functions.

input-thumbs-hint-style

Type: :table

Default: @{:bg "0" :fg "3"}

The style of hint text in (input/thumbs).

input-thumbs-match-style

Type: :table

Default: @{:bg "0" :fg "1"}

The style of match text in (input/thumbs).

input-thumbs-partial-style

Type: :table

Default: @{:bg "4" :fg "15"}

The style of partially selected hint text in (input/thumbs).

num-search-workers

Type: :number

Default: 0

The number of goroutines to use for searching in .borg files. Defaults to the number of CPUs.

remove-pane-on-exit

Type: :boolean

Default: false

If this is true, when a pane's process exits or its node is killed (such as with tree/rm), the portion of the layout related to that node will be removed. This makes cy's layout functionality work a bit more like tmux.