Parameters

cy contains a primitive key-value store it refers to as parameters. In addition to being available for use from Janet for arbitrary purposes, parameters are also the primary means of configuring cy's behavior.

Parameters are set with cy/set and retrieved with cy/get:

(cy/set :some-parameter true)

(cy/get :some-parameter)
# returns true

Default parameters

Some parameters are used by cy to change how it performs certain operations.

ParameterDefaultDescription
:data-dirinferred on startupthe directory in which .borg files are saved; if empty, recording to file is disabled
:animatetruewhether animations are enabled (disabled over SSH connections by default)
:default-shellinferred from $SHELL on startupthe default command used for cmd/new