Interface AddAnxOptions

AddAnxOptions defines the supported options for the git-annex add command.

Hierarchy

Properties

--backend? --debug? --debugfilter? --dry-run? --explain? --fast? --force? --force-large? --force-small? --jobs? --json? --json-error-messages? --json-progress? --mincopies? --no-check-gitignore? --no-debug? --numcopies? --quiet? --size-limit? --time-limit? --update? --verbose? -c? matching?

Properties

Optional --backend

--backend?: string

Specifies the key-value backend to use. Method GitAnnexAPI.getBackends obtains a list of backend names.

Optional --debug

--debug?: null

Displays debug messages.

Optional --debugfilter

--debugfilter?: string | string[]

Shows debug messages coming from a module.

Optional --dry-run

--dry-run?: null

Outputs what would be done for each file, but avoids making any changes.

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 --force

--force?: null

Allows actions that may lose annexed data

Optional --force-large

--force-large?: null

Treats all files as large files, ignoring annex.largefiles and annex.dotfiles configuration, and adds to git-annex.

Optional --force-small

--force-small?: null

Treats all files as small files, ignoring annex.largefiles, annex.dotfiles and annex.addsmallfiles configuration, and adds to git.

Optional --jobs

--jobs?: string | number

Specifies the number of cores to use for adding multiple files in parallel.

Optional --json

--json?: null

Produces a JSON object on each line of output. Type predicate isActionResult may be passed to safeParse or safeParseToArray when processing the output.

Optional --json-error-messages

--json-error-messages?: null

Includes error messages in the json instead of sending them to standard error.

Optional --json-progress

--json-progress?: null

Includes progress objects in JSON output. Specifying --json-progress automatically enables --json. Type predicate isActionProgress may be passed to safeParse or safeParseToArray when processing the output.

Optional --mincopies

--mincopies?: string | number

Overrides the mincopies setting.

Optional --no-check-gitignore

--no-check-gitignore?: null

Adds gitignored files.

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 --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 --update

--update?: null

Updates to tracked files are added to the index.

Optional --verbose

--verbose?: null

Enables verbose display.

Optional -c

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

Overrides Git configuration settings.

Optional matching

matching?: string | string[]

Specifies the file matching options.

Matching is an anonymous option. The name matching is not presented to the git-annex command. The values passed to the matching option are passed to git-annex in the order provided.

Consult the git-annex matching options documentation for the possible options.

Settings

Member Visibility

Theme

On This Page