Interface SyncOptions

SyncOptions defines the supported options for the git-annex sync command.

Hierarchy

Properties

--all? --allow-unrelated-histories? --backend? --cleanup? --commit? --content? --content-of? --debug? --debugfilter? --explain? --fast? --force? --jobs? --message? --mincopies? --no-allow-unrelated-histories? --no-commit? --no-content? --no-debug? --no-pull? --no-push? --no-resolvemerge? --not-only-annex? --numcopies? --only-annex? --pull? --push? --quiet? --resolvemerge? --size-limit? --time-limit? --verbose? -c?

Properties

Optional --all

--all?: null

Requests all available versions of files be synced.

Optional --allow-unrelated-histories

--allow-unrelated-histories?: null

Controls whether to merge histories that do not share a common ancestor. See also --no-allow-unrelated-histories.

Optional --backend

--backend?: string

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

Optional --cleanup

--cleanup?: null

Removes the local and remote synced/ branches created and pushed by git-annex sync.

Optional --commit

--commit?: null

The complement of --no-commit.

Optional --content

--content?: null

Causes the content of annexed files to also be uploaded and downloaded as necessary. See also --no-content.

Optional --content-of

--content-of?: string | string[]

Limits the transferred files to the specified relative paths. If specified, helper function gitPath or gitPaths is called internally.

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

--jobs?: string | number

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

Optional --message

--message?: string

Specifies the commit message.

Optional --mincopies

--mincopies?: string | number

Overrides the mincopies setting.

Optional --no-allow-unrelated-histories

--no-allow-unrelated-histories?: null

The complement of --allow-unrelated-histories.

Optional --no-commit

--no-commit?: null

Avoids committing local changes. See also --commit.

Optional --no-content

--no-content?: null

The complement of --content.

Optional --no-debug

--no-debug?: null

Prevents debug message display.

Optional --no-pull

--no-pull?: null

Disables all pulling. See also --pull.

Optional --no-push

--no-push?: null

Disables all pushing. See also --push.

Optional --no-resolvemerge

--no-resolvemerge?: null

Disables automatic merge conflict resolution. See also --resolvemerge.

Optional --not-only-annex

--not-only-annex?: null

The complement of --only-annex.

Optional --numcopies

--numcopies?: string | number

Overrides the numcopies setting.

Optional --only-annex

--only-annex?: null

Syncs only the git-annex branch and annexed content, not other Git branches. See also --not-only-annex.

Optional --pull

--pull?: null

The complement of --no-pull.

Optional --push

--push?: null

The complement of --no-push.

Optional --quiet

--quiet?: null

Suppresses verbose output.

Optional --resolvemerge

--resolvemerge?: null

The complement of --no-resolvemerge.

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