Skip to main content

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 animation-delay animation-fps animations color-error color-info color-map color-warn data-directory default-frame default-shell history-limit input-find-active-style input-find-highlight-style input-find-inactive-style input-find-wrap 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-view-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-block-mode replay-text-visual-circle-mode replay-text-visual-line-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.

animation-delay​

Type: :number

Default: 0

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.

animation-fps​

Type: :number

Default: 23

The target frames per second (FPS) for animations.

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.

history-limit​

Type: :number

Default: 5000

The maximum number of physical lines kept in memory for a pane's scrollback buffer. When recording to disk, this is the amount of scrollback available in copy mode before cy loads the full history from the .borg file. A non-positive value disables pruning.

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-find-wrap​

Type: :boolean

Default: true

Whether (input/find) should wrap around when moving past the first or last option.

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-view-on-exit​

Type: :boolean

Default: false

If this is true, when a view'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.

replay-copy-style​

Type: :table

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

The style used to represent copy mode.

replay-incremental-style​

Type: :table

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

The style for incremental search in replay mode.

replay-match-active-style​

Type: :table

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

The style for the current search match in replay mode.

replay-match-inactive-style​

Type: :table

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

The style for search matches in replay mode.

replay-play-style​

Type: :table

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

The style used in time mode when the player is playing.

replay-selection-style​

Type: :table

Default: @{:bg "8" :fg "9"}

The style for selections in replay mode.

replay-status-bar-style​

Type: :table

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

The style of the status bar in replay mode.

replay-text-copy-mode​

Type: :string

Default: "COPY"

The text shown in the status bar when in copy mode.

replay-text-play-mode​

Type: :string

Default: "⏸"

The text shown in the status bar when playing.

replay-text-time-mode​

Type: :string

Default: "⏵"

The text shown in the status bar when in time mode.

replay-text-visual-block-mode​

Type: :string

Default: "VISUAL BLOCK"

The text shown in the status bar when in visual block mode.

replay-text-visual-circle-mode​

Type: :string

Default: "VISUAL CIRCLE"

The text shown in the status bar when in visual circle mode.

replay-text-visual-line-mode​

Type: :string

Default: "VISUAL LINE"

The text shown in the status bar when in visual line mode.

replay-text-visual-mode​

Type: :string

Default: "VISUAL"

The text shown in the status bar when in visual mode.

replay-time-style​

Type: :table

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

The style used to represent time mode.

replay-visual-style​

Type: :table

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

The style used to represent visual mode.

search-status-bar-style​

Type: :table

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

The style of the status bar in search mode.

search-text-no-matches-found​

Type: :string

Default: "no matches found for"

The text shown in the status bar when no matches are found.

search-text-searching​

Type: :string

Default: "searching"

The text shown in the status bar when searching.

terminal-text-exited​

Type: :string

Default: "exited"

The text shown when a terminal session exits.

timestamp-format​

Type: :string

Default: "2006-01-02 15:04:05"

The format for all timestamps shown in cy. This uses Go's time.Layout format described here.

use-system-clipboard​

Type: :boolean

Default: false

Whether to use the system clipboard instead of outputting OSC-52 codes. This should generally be "true" unless you use an old terminal emulator.