@peiyanlu/git-utils 0.0.0-stage → 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 YanluPei
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,24 @@
-# Temporary Holding Version
+# @peiyanlu/git-utils
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+
+[![module](https://img.shields.io/badge/package-ESM--only-FFE536.svg?logo=npm)](https://nodejs.org/api/esm.html)
+[![npm](https://img.shields.io/npm/v/@peiyanlu/git-utils.svg)](https://npmjs.com/package/@peiyanlu/git-utils)
+[![license](https://img.shields.io/npm/l/@peiyanlu/git-utils.svg)](https://npmjs.com/package/@peiyanlu/git-utils)
+[![downloads](https://img.shields.io/npm/dm/@peiyanlu/git-utils.svg)](https://npmjs.com/package/@peiyanlu/git-utils)
+[![node](https://img.shields.io/node/v/@peiyanlu/git-utils.svg)](https://nodejs.org)
+[![size](https://packagephobia.com/badge?p=@peiyanlu/git-utils)](https://packagephobia.com/result?p=@peiyanlu/git-utils)
+[![deps](https://img.shields.io/librariesio/release/npm/@peiyanlu/git-utils)](https://libraries.io/npm/%40peiyanlu%2Fgit-utils)
+
+A Node.js and TypeScript library for common Git commands and workflows.
+
+## Installation
+
+```shell
+pnpm add @peiyanlu/git-utils
+```
+
+## Usage
+
+```ts
+import { gitAdd, gitCommit, gitPush } from '@peiyanlu/git-utils'
+```

package/dist/index.d.mts

@@ -0,0 +1,607 @@
+import { CommandOutput, SpawnAsyncOpts, SpawnSyncOpts } from "@peiyanlu/command-utils";
+/**
+ * 暂存所有文件
+ * @defaults `git add --all`
+ */
+export declare const gitAddAll: (args?: string[]) => Promise<void>;
+/**
+ * 暂存已追踪文件
+ * @defaults `git add --update`
+ */
+export declare const gitAddTracked: (args?: string[]) => Promise<void>;
+/**
+ * 获取当前分支
+ * @defaults `git branch --show-current`
+ * */
+export declare const gitBranchCurrent: () => Promise<string>;
+/**
+ * 重命名本地分支
+ * @defaults `git branch -m <old-name> <new-name>`
+ */
+export declare const gitBranchMove: (oldName: string, newName: string) => Promise<void>;
+/**
+ * 重命名本地分支（强制）
+ * @defaults `git branch -M <old-name> <new-name>`
+ */
+export declare const gitBranchMoveForce: (oldName: string, newName: string) => Promise<void>;
+/**
+ * 删除本地分支
+ * @defaults `git branch -d <branch>`
+ */
+export declare const gitBranchDelete: (branch: string) => Promise<void>;
+/**
+ * 删除本地分支（强制）
+ * @defaults `git branch -D <branch>`
+ */
+export declare const gitBranchDeleteForce: (branch: string) => Promise<void>;
+/** 获取所有分支 */
+export declare const getLocalBranches: () => Promise<string[]>;
+export declare const getRemoteBranches: () => Promise<string[]>;
+/**
+ * 创建并签出
+ * @defaults `git checkout -b <branch> <start-point>`
+ * @fallback `git checkout <branch>`
+ * @see
+ * ```
+ * git branch <branch> <start-point>
+ * git checkout <branch>
+ * ```
+ */
+export declare const gitCheckoutBranch: (branch: string, startpoint?: string) => Promise<void>;
+/**
+ * 强制创建/重置并签出
+ * @defaults `git checkout -B <branch> <start-point>`
+ * @see
+ * ```
+ * git checkout <start-point>
+ * git branch -f <branch> HEAD
+ * git checkout <branch>
+ * ```
+ */
+export declare const gitCheckoutBranchForce: (branch: string, startpoint?: string) => Promise<void>;
+/**
+ * 创建孤儿分支
+ * @defaults `git checkout --orphan <branch>`
+ */
+export declare const gitCheckoutBranchOrphan: (branch: string, startpoint?: string) => Promise<void>;
+/**
+ * 提交
+ * @defaults `git commit --message message <args>`
+ */
+export declare const gitCommitMessage: (message: string, args?: string[]) => Promise<void>;
+/**
+ * 空内容提交
+ * @defaults `git commit --message message --allow-empty <args>`
+ */
+export declare const gitCommitAllowEmpty: (message: string, args?: string[]) => Promise<void>;
+/**
+ * 修正提交
+ * @defaults `git commit --message message --amend <args>`
+ */
+export declare const gitCommitAmend: (message: string, args?: string[]) => Promise<void>;
+/**
+ * 修正提交 保留信息
+ * @defaults `git commit --amend --no-edit <args>`
+ */
+export declare const gitCommitAmendNoEdit: (args?: string[]) => Promise<void>;
+/**
+ * 获取指定的 git 配置
+ * @defaults `git config [--global] --get <key>`
+ */
+export declare const gitConfigGet: (key: string, global?: boolean) => Promise<string | undefined>;
+/**
+ * 指定的 git 配置
+ * @defaults `git config [--global] <key> <value>`
+ */
+export declare const gitConfigSet: (key: string, value: string, global?: boolean) => Promise<void>;
+/**
+ * 移除指定配置
+ * @defaults `git config [--global] --unset <key>`
+ */
+export declare const gitConfigUnset: (key: string, global?: boolean) => Promise<void>;
+/**
+ * 配置列表
+ * @defaults `git config [--global] --list`
+ */
+export declare const gitConfigList: (global?: boolean) => Promise<string | undefined>;
+/**
+ * 推送 tag 到远程
+ * @defaults `git push <remote> refs/tags/<tag> <args>`
+ */
+export declare const gitPushTag: (remote: string, tag: string, args?: string[]) => Promise<void>;
+/**
+ * 推送分支到远程
+ * 自动处理 upstream
+ * @defaults `git push <remote> <branch> [--set-upstream] <args>`
+ */
+export declare const gitPushBranch: (remote: string, branch: string, args?: string[]) => Promise<void>;
+/**
+ * 删除远程引用（分支、tag）
+ * @defaults `git push <remote> <ref> --delete <args>`
+ */
+export declare const gitPushDeleteRef: (remote: string, ref: string, args?: string[]) => Promise<void>;
+/**
+ * 获取 url
+ * @defaults `git remote get-url <args>`
+ */
+export declare const gitRemoteGetUrl: (args: string[]) => Promise<string | undefined>;
+/**
+ * 设置 url
+ * @defaults `git remote set-url <args>`
+ */
+export declare const gitRemoteSetUrl: (args: string[]) => Promise<void>;
+/**
+ * 添加远程
+ * @defaults `git remote add <name> <url>`
+ */
+export declare const gitRemoteAdd: (name: string, url: string) => Promise<void>;
+/**
+ * 重命名远程
+ * @defaults `git remote rename <old-name> <new-name>`
+ */
+export declare const gitRemoteRename: (oldName: string, newName: string) => Promise<void>;
+/**
+ * 移除远程
+ * @defaults `git remote remove <name>`
+ */
+export declare const gitRemoteRemove: (name: string) => Promise<void>;
+/** 获取关联的所有远程 */
+export declare const getRemoteNames: () => Promise<string[]>;
+/** 获取远程地址 */
+export declare const getRemoteUrl: (remote: string) => Promise<string | undefined>;
+/** 获取所有远程 */
+export declare const getRemoteList: () => Promise<{
+  name: string;
+  url?: string;
+}[]>;
+/**
+ * 创建 lightweight tag
+ * @defaults `git tag <tag> <args>`
+ */
+export declare const gitTagLightweight: (tag: string, args?: string[]) => Promise<void>;
+/**
+ * 创建 annotated tag
+ * @defaults `git tag --annotate --message <msg> <tag> <args>`
+ */
+export declare const gitTagAnnotated: (tag: string, message?: string, args?: string[]) => Promise<void>;
+/**
+ * 创建 signed tag
+ * @defaults `git tag --sign --message <msg> <tag> <args>`
+ */
+export declare const gitTagSigned: (tag: string, message?: string, args?: string[]) => Promise<void>;
+/**
+ * 删除本地 tag
+ * @defaults `git tag --delete <tag> <args>`
+ */
+export declare const gitTagDelete: (tag: string, args?: string[]) => Promise<void>;
+/** {@link gitTagDelete} 的同步版本 */
+export declare const gitTagDeleteSync: (tag: string, args?: string[]) => void;
+export type SortKey = "v:refname" | "creatordate";
+export type GitSort = SortKey | `-${SortKey}`;
+export declare enum GitSorter {
+  NAME_ASC = "v:refname",
+  NAME_DESC = "-v:refname",
+  DATE_ASC = "creatordate",
+  DATE_DESC = "-creatordate"
+}
+/**
+ * 获取本地所有 tag
+ * @defaults `git for-each-ref refs/tags/<match> --format "%(refname:short)" --sort <sort>
+ *   --exclude refs/tags/<match> --count <count>`
+ */
+export declare const getLocalTags: (match?: string, exclude?: string | string[], sort?: GitSort, count?: number) => Promise<string[]>;
+/**
+ * 获取远程所有 tag
+ * @defaults `git ls-remote --tags --refs --sort <sort> <remote>`
+ */
+export declare const getRemoteTags: (remote?: string, sort?: GitSort) => Promise<string[]>;
+/** 获取最新 tag */
+export declare const getLatestTag: (match?: string, exclude?: string | string[]) => Promise<string>;
+/** 获取上一个 tag */
+export declare const getPreviousTag: (tag: string, match?: string, exclude?: string | string[]) => Promise<string>;
+/**
+ * 安全撤销一个已提交（并可能已 push）的 commit
+ * @defaults `git revert <commit>`
+ */
+export declare const gitRevertCommit: (hash: string) => Promise<void>;
+/** 初始化裸仓库，模拟远程仓库 */
+export declare const initBareRepo: (dir: string) => Promise<void>;
+/** 初始化仓库 */
+export declare const initRepo: (branch?: string) => Promise<void>;
+/** 判断指定目录是否是 git 仓库 */
+export declare const isGitRepo: (dir?: string) => Promise<boolean>;
+/** 判断指定目录是否是 git 裸仓库 */
+export declare const isGitBareRepo: (dir?: string) => Promise<boolean>;
+/** 判断工作区是否干净 */
+export declare const isWorkingTreeClean: () => Promise<boolean>;
+/**
+ * 判断当前分支是否已设置 upstream
+ * @defaults `git rev-parse --abbrev-ref --symbolic-full-name "<branch>@{u}"`
+ */
+export declare const hasUpstream: (branch?: string) => Promise<boolean>;
+/**
+ * 获取完整 hash
+ * @defaults `git rev-parse <rev>`
+ */
+export declare const getFullHash: (rev: string) => Promise<string | undefined>;
+/**
+ * 获取短 hash
+ * @defaults `git rev-parse --short <rev>`
+ */
+export declare const getShortHash: (rev: string) => Promise<string | undefined>;
+/**
+ * 提取所有分支
+ * @defaults `git fetch --all --prune`
+ */
+export declare const fetchAllPrune: () => Promise<void>;
+/**
+ * 获取当前工作区状态
+ * @defaults `git status --short --untracked-files=no`
+ */
+export declare const getShortStatus: () => Promise<string | undefined>;
+/**
+ * 为 git status / changeset 输出添加颜色
+ *
+ * M -> 黄色（修改）
+ * A -> 绿色（新增）
+ * D -> 红色（删除）
+ * @param {string} log `git status --short` 输出
+ * @returns {string}
+ */
+export declare const coloredStatus: (log: string) => string;
+/**
+ * 计算 changelog 的 commit 范围
+ * @param {boolean} isIncrement 是否为版本递增发布
+ * @param {string} match tag match
+ * @param {string} exclude tag exclude
+ * @returns {Promise<{from: string, to: string}>}
+ */
+export declare const resolveChangelogRange: (isIncrement?: boolean, match?: string, exclude?: string | string[]) => Promise<{
+  from: string;
+  to: string;
+}>;
+/**
+ * 获取指定范围内的 commit 日志
+ * @defaults `git log --pretty=format:"* %s (%h)" <from>...<to> -- <scope>`
+ */
+export declare const getLogSince: (from?: string, to?: string, scope?: string) => Promise<string | undefined>;
+/** 判断字符串是否为合法 remote 名称 */
+export declare const isRemoteName: (remote: string) => Promise<boolean>;
+/** 统计自 tag 以来的提交数量 */
+export declare const countCommitsSince: (tag?: string) => Promise<number>;
+/**
+ * 将 HEAD 指向指定分支（不会切换工作区）
+ */
+export declare const gitSetHeadBranch: (branch: string) => Promise<void>;
+/** 删除当前分支引用 */
+export declare const gitDeleteHeadRef: () => Promise<void>;
+/**
+ * 创建一个没有任何提交的分支状态。
+ */
+export declare const createUnbornBranch: (branch: string) => Promise<void>;
+export declare const headArg: (count?: number) => string;
+/**
+ * 撤销最近的 commit（移动 HEAD + 取消暂存）
+ * - 暂存区被重置到目标 commit
+ * - 未提交修改保持不变
+ * @defaults `git reset --mixed HEAD~<count>`
+ */
+export declare const gitResetMixed: (count?: number) => Promise<void>;
+/**
+ * 撤销最近的 commit（完全重置）
+ * - 暂存区 + 工作区都会被重置到目标 commit
+ * - 未提交修改会丢失
+ * @defaults `git reset --hard HEAD~<count>`
+ */
+export declare const gitResetHard: (count?: number) => Promise<void>;
+/**
+ * 撤销最近的 commit（仅移动 HEAD）
+ * - 暂存区保持不变
+ * - 未提交修改保持不变
+ * @defaults `git reset --soft HEAD~<count>`
+ */
+export declare const gitResetSoft: (count?: number) => Promise<void>;
+/**
+ * 撤销最近的 commit（安全重置）
+ * - 行为类似 --hard
+ * - 若会覆盖工作区未提交修改则直接失败
+ * @defaults `git reset --keep HEAD~<count>`
+ */
+export declare const gitResetKeep: (count?: number) => Promise<void>;
+/** {@link gitResetMixed} 的同步版本 */
+export declare const gitResetMixedSync: (count?: number) => void;
+/** {@link gitResetHard} 的同步版本 */
+export declare const gitResetHardSync: (count?: number) => void;
+/** {@link gitResetSoft} 的同步版本 */
+export declare const gitResetSoftSync: (count?: number) => void;
+/** {@link gitResetKeep} 的同步版本 */
+export declare const gitResetKeepSync: (count?: number) => void;
+/**
+ * 用【暂存区】覆盖【工作区】单个文件
+ * - 用 Index 覆盖 Working Tree
+ * - 不影响暂存区（Index）
+ * @defaults `git restore --worktree <file>`
+ */
+export declare const gitRestoreFile: (file: string) => Promise<void>;
+/**
+ * 用【暂存区】覆盖【工作区】所有文件
+ * - 用 Index 覆盖 Working Tree
+ * - 不影响暂存区（Index）
+ * @defaults `git --worktree restore .`
+ */
+export declare const gitRestoreAll: () => Promise<void>;
+/**
+ * 用 指定 source 中的文件内容覆盖【工作区】文件
+ * - 仅修改 Working Tree
+ * - 不影响暂存区（Index）
+ * - 不会改变提交历史（HEAD）
+ * @defaults `git restore --worktree --source <source> <file>`
+ * @see source = `git rev-parse <expr>`
+ */
+export declare const gitRestoreWorktreeFileFrom: (source: string, file: string) => Promise<void>;
+/**
+ * 用指定 source 中的文件内容覆盖【工作区】所有文件
+ * - 仅修改 Working Tree
+ * - 不影响暂存区（Index）
+ * - 不会改变提交历史（HEAD）
+ * @defaults `git restore --worktree --source <source> .`
+ * @see source = `git rev-parse <expr>`
+ */
+export declare const gitRestoreWorktreeAllFrom: (source: string) => Promise<void>;
+/**
+ * 用指定 source 覆盖【暂存区】中的文件
+ * - 用 source 覆盖 Index
+ * - 不影响工作区（Working Tree）
+ * - 不会改变提交历史（HEAD）
+ * @defaults `git restore --staged --source <source> <file>`
+ * @see source = `git rev-parse <expr>`
+ */
+export declare const gitRestoreIndexFileFrom: (source: string, file: string) => Promise<void>;
+/**
+ * 用指定 source 覆盖整个【暂存区】
+ * - 用 source 覆盖 Index
+ * - 不影响工作区（Working Tree）
+ * - 不会改变提交历史（HEAD）
+ * @defaults `git restore --staged --source <source> .`
+ * @see source = `git rev-parse <expr>`
+ */
+export declare const gitRestoreIndexAllFrom: (source: string) => Promise<void>;
+/**
+ * 用指定 source 覆盖指定文件（暂存区 + 工作区）
+ * - 将 Index 和 Working Tree 恢复到 source 状态
+ * - 不会移动 HEAD
+ * - 不会改变提交历史
+ * @defaults `git restore --staged --worktree --source <source> <file>`
+ * @see source = `git rev-parse <expr>`
+ */
+export declare const gitRestoreFileFrom: (source: string, file: string) => Promise<void>;
+/**
+ * 用指定 source 覆盖所有文件（暂存区 + 工作区）
+ * - 将 Index 和 Working Tree 恢复到 source 状态
+ * - 不会移动 HEAD
+ * - 不会改变提交历史
+ * @defaults `git restore --staged --worktree --source <source> .`
+ * @see source = `git rev-parse <expr>`
+ */
+export declare const gitRestoreAllFrom: (source: string) => Promise<void>;
+/**
+ * 取消单个文件的暂存状态
+ * - 用 HEAD 覆盖暂存区（Index）
+ * - 不影响工作区（Working Tree）
+ * - 等价于撤销 git add
+ * @defaults `git restore --staged <file>`
+ */
+export declare const gitUnstageFile: (file: string) => Promise<void>;
+/**
+ * 取消所有文件的暂存状态
+ * - 用 HEAD 覆盖暂存区（Index）
+ * - 不影响工作区（Working Tree）
+ * - 等价于撤销所有 git add
+ * @defaults `git restore --staged .`
+ */
+export declare const gitUnstageAll: () => Promise<void>;
+/**
+ * 丢弃指定文件的所有修改（暂存区 + 工作区）
+ * - 强制将文件恢复到 HEAD 状态
+ * - 同时重置 Index 和 Working Tree
+ * - 不会改变提交历史（HEAD）
+ * @defaults `git restore --source=HEAD --staged --worktree <file>`
+ */
+export declare const gitDiscardFile: (file: string) => Promise<void>;
+/**
+ * 丢弃所有文件的所有修改（暂存区 + 工作区）
+ * - 强制将整个工作区恢复到 HEAD 状态
+ * - 行为等价于 git reset --hard HEAD（按文件粒度）
+ * - 不会删除未跟踪文件（untracked files）
+ * @defaults `git restore --source=HEAD --staged --worktree .`
+ */
+export declare const gitDiscardAll: () => Promise<void>;
+/**
+ * 引用解析操作
+ * @defaults `git rev-parse <args>`
+ */
+export declare const gitRevParse: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitRevParse} 的同步版本 */
+export declare const gitRevParseSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 提交遍历操作
+ * @defaults `git rev-list <args>`
+ */
+export declare const gitRevList: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitRevList} 的同步版本 */
+export declare const gitRevListSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 引用遍历操作
+ * @defaults `git for-each-ref <args>`
+ */
+export declare const gitForEachRef: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitForEachRef} 的同步版本 */
+export declare const gitForEachRefSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 暂存操作
+ * @defaults `git add <args>`
+ */
+export declare const gitAdd: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitAdd} 的同步版本 */
+export declare const gitAddSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 分支操作
+ * @defaults `git branch <args>`
+ */
+export declare const gitBranch: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitBranch} 的同步版本 */
+export declare const gitBranchSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 迁出操作
+ * @defaults `git checkout <args>`
+ */
+export declare const gitCheckout: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitCheckout} 的同步版本 */
+export declare const gitCheckoutSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 提交操作
+ * @defaults `git commit <args>`
+ */
+export declare const gitCommit: (args?: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitCommit} 的同步版本 */
+export declare const gitCommitSync: (args?: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 配置操作
+ * @defaults `git config <args>`
+ */
+export declare const gitConfig: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitConfig} 的同步版本 */
+export declare const gitConfigSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 符号引用操作
+ * @defaults `git symbolic-ref <args>`
+ */
+export declare const gitSymbolicRef: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitSymbolicRef} 的同步版本 */
+export declare const gitSymbolicRefSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 引用更新操作
+ * @defaults `git update-ref <args>`
+ */
+export declare const gitUpdateRef: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitUpdateRef} 的同步版本 */
+export declare const gitUpdateRefSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 推送操作
+ * @defaults `git push <args>`
+ */
+export declare const gitPush: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitPush} 的同步版本 */
+export declare const gitPushSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 远程操作
+ * @defaults `git remote <args>`
+ */
+export declare const gitRemote: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitRemote} 的同步版本 */
+export declare const gitRemoteSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * tag 操作
+ * @defaults `git tag <args>`
+ */
+export declare const gitTag: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitTag} 的同步版本 */
+export declare const gitTagSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 重置操作
+ * @defaults `git reset <args>`
+ */
+export declare const gitReset: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitReset} 的同步版本 */
+export declare const gitResetSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 恢复操作
+ * @defaults `git restore <args>`
+ */
+export declare const gitRestore: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitRestore} 的同步版本 */
+export declare const gitRestoreSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 回退操作
+ * @defaults `git revert <args>`
+ */
+export declare const gitRevert: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitRevert} 的同步版本 */
+export declare const gitRevertSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 远程引用查询操作
+ * @defaults `git ls-remote <args>`
+ */
+export declare const gitLsRemote: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitLsRemote} 的同步版本 */
+export declare const gitLsRemoteSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 状态查询操作
+ * @defaults `git status <args>`
+ */
+export declare const gitStatus: (args?: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitStatus} 的同步版本 */
+export declare const gitStatusSync: (args?: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 对象查看操作
+ * @defaults `git show <args>`
+ */
+export declare const gitShow: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitShow} 的同步版本 */
+export declare const gitShowSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 差异比较操作
+ * @defaults `git diff <args>`
+ */
+export declare const gitDiff: (args?: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitDiff} 的同步版本 */
+export declare const gitDiffSync: (args?: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 暂存区保存操作
+ * @defaults `git stash <args>`
+ */
+export declare const gitStash: (args?: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitStash} 的同步版本 */
+export declare const gitStashSync: (args?: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 删除文件操作
+ * @defaults `git rm <args>`
+ */
+export declare const gitRm: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitRm} 的同步版本 */
+export declare const gitRmSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 移动文件操作
+ * @defaults `git mv <args>`
+ */
+export declare const gitMv: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitMv} 的同步版本 */
+export declare const gitMvSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 对象内容操作
+ * @defaults `git cat-file <args>`
+ */
+export declare const gitCatFile: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitCatFile} 的同步版本 */
+export declare const gitCatFileSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 日志查询操作
+ * @defaults `git log <args>`
+ */
+export declare const gitLog: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitLog} 的同步版本 */
+export declare const gitLogSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 仓库初始化操作
+ * @defaults `git init <args>`
+ */
+export declare const gitInit: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitInit} 的同步版本 */
+export declare const gitInitSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;
+/**
+ * 获取远程更新操作
+ * @defaults `git fetch <args>`
+ */
+export declare const gitFetch: (args: string[], options?: SpawnAsyncOpts) => Promise<CommandOutput>;
+/** {@link gitFetch} 的同步版本 */
+export declare const gitFetchSync: (args: string[], options?: SpawnSyncOpts) => CommandOutput;