platano-git
v0.3.3
Published
A cli for simplifying git operations
Downloads
463
Readme
简体中文 | English
platano-git
一个用于简化 git 操作的工具
提示
[!TIP] 如果你是用的版本是 0.2+, node的最低版本应该 18+.
使用指南
安装
使用 npm
npm install platano-git -g
使用 yarn
yarn global add platano-git
适用 pnpm
pnpm add -g platano-git
* 通过运行 platano -v
0.2.0+ 或者 platano --version
查看是否安装成功
示例
# 查看本地分支
platano br
# 推送代码
platano ps
# 拉取代码
platano pl
# 切换到main分支
platano ck main
命令
br
| 参数| 描述 | 等价命令| 备注 | 示例 |
| --- | --- | --- | --- | --- |
| [branch]
| 查看所有本地分支或创建新分支 | git branch
| 如果不输入任何内容(platano br
),控制台将输出完整的本地分支信息。 如果输入一个分支(platano br xxx
),它将创建一个名为xxx
的新分支。 请注意,此命令不会自动切换到新创建的分支。|
| -a
| 查看所有分支 | git branch -a
|
| -m [branch]
| 重命名本地分支 | git branch -m xxx yyy
| 如果不输入任何内容(platano br -m
),会提示您选择基准分支,输入新分支名。 如果输入一个分支(platano br -m xxx
),会将当前分支重命名为xxx
| |
| -s
| 删除远程分支时,选择指定的远端名称,默认是 origin
| -
|
| -d
| 删除本地分支 | git branch -D xxx
| 会强制删除分支 |
| -r
| 删除远程分支 | git push xxx --delete yyy
|
| -dr
| 删除本地和关联的远程分支 | git branch -D yyy && git push xxx --delete yyy
| | |
ck
| 参数| 描述 | 等价命令| 备注 |
| --- | --- | --- | --- |
| [branch]
| 切换分支 | git checkout xxx
| 如果输入分支,如platano ck main
,将切换到 main
分支。 如果不输入任何内容(platano ck
),将得到一个单选列表,可以在其中选择想要切换到的分支,选择一个分支后将切换到该分支。 |
| -r
| 获取远端分支当创建分支时 | | 只有和 -b
一起使用时才生效 |
| -b [branch]
| 创建新分支并切换到此分支 | git checkout -b xxx yyy
| 如果输入分支,例如 platano ck -b feat-xxx
,然后从分支列表中选择基准分支,它将基于选择的基准分支创建一个新分支 feat-xxx
。 如果不输入任何内容(platano ck -b
),它会提示需要输入新分支名称,然后选择基准分支,基于选择的基准分支创建一个新分支并切换到此分支。 |
sw
| 参数| 描述 | 等价命令| 备注 | 示例 |
| --- | --- | --- | --- | --- |
| [branch]
| 切换分支 | git switch xxx
| 如果输入分支,如platano sw main
,将切换到 main
分支。 如果不输入任何内容(platano sw
),将得到一个单选列表,可以在其中选择想要切换到的分支,选择一个分支后将切换到该分支。 | |
| -r
| 获取远端分支当创建分支时 | | 只有和 -c
一起使用时才生效 |
| -c [branch]
| 创建新分支并切换到此分支 | git switch -c xxx yyy
| 如果输入分支,例如 platano sw -c feat-xxx
,然后从分支列表中选择基准分支,它将基于选择的基准分支创建一个新分支 feat-xxx
。 如果不输入任何内容(platano sw -c
),它会提示需要输入新分支名称,然后选择基准分支,基于选择的基准分支创建一个新分支并切换到此分支。 | |
* 此命令的最低 git 版本为 2.23
pl
| 参数| 描述 | 等价命令 | 备注 | 示例 |
| --- | --- | --- | --- | --- |
|
| 拉取最新远程代码 | git pull
|
| -s
| 选择远程名称并拉取远程分支| git pull xxx yyy
| | |
ps
| 参数| 描述 | 等价命令|
| --- | --- | --- |
|
| 推送代码到远端,如果远端没有当前分支,会默认创建该分支 | git push origin currentBranch
|
| -s
| 将代码推送到远程分支,默认是 origin
| git push xxx yyy
|
| -f
| 强制推送代码 | git push xxx yyy -f
|
| -u
| 推送并关联远程分支 | git push --set-upstream xxx yyy
|
mr
| 参数| 描述 | 等价命令| 备注 |
| --- | --- | --- | --- |
| [branch]
| 合并分支 | git merge xxx
| 如果输入分支,如platano mr feat-xxx
,将合并feat-xxx
分支。 如果不输入任何内容(platano mr
),将得到一个单选列表,可以在其中选择想要合并的分支,选择一个分支后将合并该分支。 |
反馈
如果遇到了问题或有好的想法和建议,请在此 报告 。