Skip to content

TemporaryVault.register method

TemporaryVault › register

Registers this vault in the running Obsidian instance so the CLI can target it.

Pushes the vault directory to the target device first, via TemporaryVault.syncToDevice — a no-op on a transport whose app already reads the host filesystem. That ordering used to be the caller's to remember, and a caller who forgot got a silently **empty** vault rather than an error: every pre-registration TemporaryVault.populate write stayed on the host while the app opened the device's copy. Folding it in here makes populate-then-register correct on every transport.

The transport is resolved once and handed to both steps, so a push and the registration that follows it can never land on two different transports.

Signature:

register(transportOverride?: ObsidianTransport | undefined): Promise<void>

Parameters:

ParameterTypeDescription
transportOverride?ObsidianTransport | undefinedAn explicit transport to use. When omitted, falls back to the transport configured via the context provider.

Returns: Promise<void>