English | 简体中文

platano-git

A tool for simplifying git operations

User Guidance

Install

Using npm

npm install platano-git -g

Using yarn

yarn global add platano-git

Using pnpm

pnpm add -g platano-git

* run platano -V or platano --version to check whether to install package successfully

Example

# View all local branches
platano br

# Push code to remote
platano ps

# Pull the latest remote code
platano pl

# Switch to main
platano ck main

Command

br

Param	Description	Equal command	Remark
[branch]	View all local branches or create a new branch	git branch	If you don't input anything (platano br), the console will log the complete local branch info. Otherwise, you input a branch (platano br xxx), it will create a new branch named xxx. Please note, it will not switch to the branch you had created.
-a	View all branches	git branch -a
-v	View details of all branches in the local repository	git branch -v
-m [branch]	Rename local branch	git branch -m xxx yyy	If you enter nothing (platano br -m), you will be prompted to select the base branch and enter a new branch name. If you enter a branch (platano br -m xxx), the current branch will be renamed to xxx
-d	Delete local branches	git branch -D xxx	It will forcefully delete branch
-r	Delete remote branches	git push origin --delete xxx
-dr	Delete local and associated remote branches	git branch -D xxx && git push origin --delete xxx

ck

Param	Description	Equal command	Remark
[branch]	Switch branch	git checkout xxx	If you input the branch, like platano ck main, it will switch to main. If you don't input anything (platano ck), you will get a radio list which you can select the branch, click one then you will switch to that branch.
-b [branch]	Create new branch and switch to this branch	git checkout -b xxx yyy	If you input the branch, like platano ck -b feat-xxx, then you select the base branch from rest branch list, it will create a new branch feat-xxx. If you don't input anything (platano ck -b), it prompts you need input the new branch, select you base branch then you will create a new branch and switch to this branch.

sw

Param	Description	Equal command	Remark
[branch]	Switch branch	git switch xxx	If you input the branch, like platano sw main, it will switch to main. If you don't input anything (platano sw), you will get a radio list which you can select the branch, click one then you will switch to that branch.
-c [branch]	Create new branch and switch to this branch	git switch -c xxx yyy	If you input the branch, like platano sw -c feat-xxx, then you select the base branch from rest branch list, it will create a new branch feat-xxx. If you don't input anything (platano sw -c), it prompts you need input the new branch, select you base branch then you will create a new branch and switch to this branch.

* The lowest supported git version is 2.23

pl

Param	Description	Equal command
	Pull the latest remote code	git pull
-s	Select the remote end and pull the remote branch	git pull xxx yyy

ps

Param	Description	Equal command
	Push code	git push
-o	Push code to remote branch	git push origin xxx
-f	Force push code	git push origin xxx -f
-u	Push and associate remote branch	git push --set-upstream origin xxx

Feedback

If you encounter problems or have good ideas and suggestions, please report here.

License

MIT