useGit API
    Preparing search index...

    Function status

    • Show the working tree status.

      Parameters

      • this: useGit API
      • Optionalpaths: readonly string[]

        Optional pathspecs used to limit the status output to specific files or directories.

      • opts: StatusOptions = {}

        Additional status options and flags.

      Returns Promise<string>

      // Default, human-readable output
      await git.status()

      // Short format with branch info
      await git.status(undefined, {
      flags: ["--short", "--branch"],
      })

      // Machine-readable output (recommended for tooling)
      await git.status(undefined, {
      flags: ["--porcelain"],
      })

      // Limit status to specific paths
      await git.status(["src", "package.json"])

      0.1.0