Interface ImportOptions

ImportOptions defines the supported options for the git-annex import command.

Hierarchy

Properties

--backend? --content? --debug? --debugfilter? --explain? --fast? --force? --from? --jobs? --json? --json-error-messages? --json-progress? --mincopies? --no-check-gitignore? --no-content? --no-debug? --numcopies? --quiet? --size-limit? --time-limit? --verbose? -c?

Properties

Optional --backend

--backend?: string

Specifies the key-value backend to use when importing from a special remote. Method GitAnnexAPI.getBackends obtains a list of backend names.

Optional --content

--content?: null

Downloads annexed content from the special remote. See also --no-content.

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

--force?: null

Allows actions that may lose annexed data

Optional --from

--from?: string

Specifies the source special remote.

Optional --jobs

--jobs?: string | number

Specifies the number of cores to use for importing 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-content

--no-content?: null

Does not download annexed content from the special remote. git-annex keys are generated from information provided by the special remote. See also --content.

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

--verbose?: null

Enables verbose display.

Optional -c

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

Overrides Git configuration settings.

Settings

Member Visibility

Theme

On This Page