Interface ConfigAnxOptions

ConfigAnxOptions defines the supported options for the git-annex config command.

Hierarchy

Properties

--debug? --debugfilter? --explain? --fast? --for-file? --force? --get? --mincopies? --no-debug? --numcopies? --quiet? --set? --show-origin? --size-limit? --time-limit? --unset? --verbose? -c?

Properties

Optional --debug

--debug?: null

Displays debug messages.

Optional --debugfilter

--debugfilter?: string | string[]

Shows debug messages coming from a module.

Optional --explain

--explain?: null

Displays explanations of what git-annex takes into account when deciding what to do.

Optional --fast

--fast?: null

Avoids slow operations normally performed by a command.

Optional --for-file

--for-file?: string

Used in combination with --show-origin to specify the filename to check in .gitattributes. Provide the file name to examine. The gitPath function is called internally.

Optional --force

--force?: null

Allows actions that may lose annexed data

Optional --get

--get?: string

Gets a configuration value. Provide the key name to interrogate.

Optional --mincopies

--mincopies?: string | number

Overrides the mincopies setting.

Optional --no-debug

--no-debug?: null

Prevents debug message display.

Optional --numcopies

--numcopies?: string | number

Overrides the numcopies setting.

Optional --quiet

--quiet?: null

Suppresses verbose output.

Optional --set

--set?: [string, string]

Sets a configuration value. Provide the key and value strings to set.

Optional --show-origin

--show-origin?: string

Shows where the value is configured. Provide the key name to examine.

Optional --size-limit

--size-limit?: string

Limits the total size of annexed files a git-annex command can process.

Optional --time-limit

--time-limit?: string

Limits the duration of a git-annex command.

Optional --unset

--unset?: string

Unsets a configuration value. Provide the key name to remove.

Optional --verbose

--verbose?: null

Enables verbose display.

Optional -c

-c?: [string, string] | [string, string][]

Overrides Git configuration settings.

Settings

Member Visibility

Theme

On This Page