Interface GetOptions

GetOptions defines the supported options for the git-annex get command.

Hierarchy

Properties

--all? --auto? --branch? --debug? --debugfilter? --explain? --failed? --fast? --force? --from? --incomplete? --jobs? --json? --json-error-messages? --json-progress? --key? --mincopies? --no-debug? --numcopies? --quiet? --size-limit? --time-limit? --unused? --verbose? -c? matching?

Properties

Optional --all

--all?: null

Obtains all available versions of all files.

Optional --auto

--auto?: null

Obtains only files that don't yet have the desired number of copies or that are preferred content of the repository.

Optional --branch

--branch?: string

Operates on files in the specified branch or treeish.

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

--failed?: null

Operates on files that recently failed to transfer.

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 remote to use.

Optional --incomplete

--incomplete?: null

Resumes any incomplete downloads of files that were started and interrupted at some point previously.

Optional --jobs

--jobs?: string | number

Enables parallel download with up to the specified number of jobs running at once.

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.

Optional --key

--key?: string

Obtains the specified key.

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

--unused?: null

Operates on files found by last run of git-annex unused.

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