Skip to content

createDesktopGitRunner

Creates a GitRunner for a folder.

Call the runner only on desktop, behind Platform.isDesktopApp. Importing this module and creating a runner are safe on mobile: Node modules are read only when the runner executes a command.

Import:

import { createDesktopGitRunner } from '@mnaoumov/obsidian-lib/desktop-git-runner';

Signature:

function createDesktopGitRunner(cwd: string): GitRunner

Parameters:

Parameter Type Description
cwd string The folder to run git in.

Returns: GitRunner — The runner.