aardio 文档

process.git 库模块帮助文档

process 成员列表

process.git("字符串参数")

创建 Git 工具。
参数 @1指定工作目录,省略则传入 "/" (应用程序根目录)。
如果系统未安装 Git 时将下载并安装 Git,
git安装程序

process.git()

返回对象:processGitObject

process.git 成员列表

process.git.getInstallPath()

获取 git.exe 安装路径。
可选用参数@1 指定未找到 git.exe 是否允许自动安装

process.git.install()

安装 Git for Windows

processGitObject 成员列表

processGitObject.add("字符串参数")

指定要添加到暂存区的文件名目录,
文件名中可使用*通配符,

暂存区(Stage)也称索引区(Index)
Index(Stage)是一个列表,用于记录有我们需要跟踪的所有文件

processGitObject.addAll()

保存添加所有新增、修改、删除文件操作,
可远在参数中指定目录

processGitObject.addNoAll()

保存添加所有修改、新增文件操作,
不包括删除文件,可远在参数中指定目录

processGitObject.addUpdate()

保存添加所有修改、删除文件操作,
不包括新增文件,可远在参数中指定目录

processGitObject.branch("--set-upstream-to=origin/master","master")

手动建立本地分支与远程分支的追踪关系

如果当前分支与远程分支存在追踪关系,pull可省略远程分支名

processGitObject.branch("-d","branch")

删除指定分支,
参数@1改为大写"-D"则强行删除未合并的分支

processGitObject.branch("branch")

创建新分支,但不会切换过去

processGitObject.branch()

列出所有分支,前面是*号的为当前分支

processGitObject.checkout("--",".")

撤消本地所有修改,
为避免提交ID与文件路径同名冲突,请在参数@1中指定"--"

processGitObject.checkout("--",filename)

用暂存区中指定文件来覆盖工作区中的对应文件,
为避免提交ID与文件路径同名冲突,请在参数@1中指定"--"

processGitObject.checkout("-b",branch)

创建并切换到branch分支

processGitObject.checkout("HEAD",filename)

直接用HEAD覆盖工作区
相当于git reset HEAD + git checkout -- filename

processGitObject.checkout(branch)

更新HEAD以指向branch分支,以及用branch指向的树更新暂存区和工作区

processGitObject.clean("-xdf")

删除当前目录下没有被track过的文件或目录
不管是否是.gitignore文件指定的文件或目录

processGitObject.clone("字符串参数")

克隆远程仓库

processGitObject.cmd()

指定一个或多个git启动参数,
进程执行完成并关闭后,返回标准输出,以及错误输出
git指令文档

processGitObject.commit()

提交暂存区更改到本地版本库,
必须在参数中使用一个字符串参数指定更改日志

processGitObject.diff("--cached")

返回暂存区和版本库的差异

processGitObject.diff("HEAD")

返回工作区和版本库的差异

processGitObject.diff()

返回工作区和暂存区的差异

processGitObject.fetch("origin","master")

取回远程仓库origin的master分支,
但不会自动与本地分支合并

processGitObject.globalUser(用户名,邮箱)

设置全局用户名、邮件

processGitObject.ignore()

在参数中使用字符串指定忽略文件.gitignore的内容
忽略文件模板

processGitObject.init()

创建版本库

processGitObject.log()

查看提交历史

processGitObject.logger

指定进程管道的默认回显对象
该对象必须有log或write成员函数用于输出回

processGitObject.merge(branch)

合并指定分支

processGitObject.open()

指定一个或多个git启动参数,返回process对象

返回对象:processObject

processGitObject.popen()

指定一个或多个git启动参数,
返回process.popen对象,

不显示git控制台窗口,
并可通过返回的进程管道读写进程输入输出

返回对象:processPopenObject

processGitObject.pull("origin","dev:master")

取回远程仓库的dev分支,
并与本地master分支合并
如果与当前分支合并,冒号后面部分可以省略,
如果当前分支与远程分支存在追踪关系,可省略远程分支名

processGitObject.pull()

如果当前分支只有一个远程追踪分支,
可省略参数直接取回该分支

processGitObject.push("origin","master")

推送master分支到远程仓库origin,
在这之前应当先将文件更改add到暂存区,
然后在commit到本地版本库,

可用remoteAdd函数添加远程仓库地址,
首次推送时可增加"-u"参数

processGitObject.push("origin,"tagName")

推送tagName指定的标签到远程仓库origin,

processGitObject.rebase()

变基操作

processGitObject.remote("-v")

查看远程仓库的信息

processGitObject.remote("add","origin","字符串参数")

添加远程仓库关联,
参数@1指定名称,参数@2指定过程仓库地址

processGitObject.remote("rm","origin")

删除远程仓库关联

processGitObject.reset("--hard","HEAD~1")

回退到上一个版本,并放弃之后的版本历史以及所有更改,
HEAD指针、暂存区、工作区都回到上次的提交状态
可以修改参数中的数字指定回退的版本数,也可以直接指定版本ID

processGitObject.reset("HEAD")

撤消对暂存区的更改并重新放回工作区,
可增加一个参数指定文件或目录

processGitObject.resetAndClean()

清空工作目录中所有未提交的内容
删除当前目录下所有没有跟踪过的文件
工作目录和缓存区恢复最近一次commit时的状态

processGitObject.resetPush(commitId)

远程仓库强制回退到指定的提交ID

processGitObject.revert("HEAD~1")

回退到上一个版本,
可生成一次新的提交,版本历史是不会被破坏,
可以修改参数中的数字指定回退的版本数,也可以直接指定版本ID

processGitObject.rm("-r","字符串参数")

自版本库和暂存区删除文件,
"-r" 参数允许递归删除目录下的文件

processGitObject.setHttpProxy(代理服务器地址)

设置 HTTP/HTTPS 代理,
参数 @1 示例: "socks5://127.0.0.1:10801",
设为 null 清除代理

processGitObject.show()

显示相关信息

processGitObject.stash("list")

列出备份的工作现场

processGitObject.stash("pop")

使用备份的工作现场恢复工作区,
并删除备份的工作现场

processGitObject.stash()

备份工作现场

processGitObject.status()

显示工作目录和暂存区的状态

processGitObject.tag("-d","tagName")

删除标签

processGitObject.tag("tagName")

设置标签

processGitObject.tag()

列出所有标签

processGitObject.user(用户名,邮箱)

设置用户名、邮件
不指定参数查看用户名、邮箱

Markdown 格式