git-x - a set of handy git extensions.
Project description
git-x - a set of handy git extensions.
Installation
pip install git-x
How to Run
Show help message
Run
git-x
, or ignore the - in git-x:
git x
It will output the help message:
$ git x
Usage: git-x [OPTIONS] COMMAND [ARGS]...
Options:
-h Show this message and exit.
Commands:
a Add files to the index
amend Amend files into repository
b Show current branch name
ci Commit all the indexed files
cia Add files into index and commit
co Check out branch <branch>, create if '-b' is True and the branch
doesn't exist.
llg Show recent <number> logs(5 by default)
m Merge codes from branch <from>
p Same as [git pull --rebase]
pr Create pull request from current branch to <to_branch>
st Show file status
up Create remote branch
Note: If you have an exe like git-x.exe in windows, or git-x.sh in linux or mac, you can run the command with git x directly. This is handled by git.
Run commands
git-x includes a list of commands, let’s take st as an example:
There are several ways to run the command:
1. Run with git-x
Run
git x st -h
Or,
git-x sh -h
It will output the help doc of sh command:
$ git x st -h
Usage: git-x st [OPTIONS]
Show file status, same as 'git status'
Options:
-h Show this message and exit.
2. Run with git- or git
You may see that in the Usage line, it shows git-st, which means that you can run the commands listed above with git-:
git-st -h
Or, even run with git:
git st -h
They both output the help doc of st command:
$ git-st -h
Usage: git-st [OPTIONS]
Show file status, same as 'git status'
Options:
-h Show this message and exit.
Usages of all commands
git st
List out all the available commands:
a Add file contents to the index amend Amend files into repository b Show current branch name ci Commit all the indexed files cia Add files into index and commit co Checkout/Create branch llg Show recent <number> logs m Merge codes from branch <from> to current branch p Pull latest code pr Create pull request from current branch to <to_branch> st Show the working tree status up Create remote branch
git a
The usage is:
Add file that specified in <pathspec> contents into the index. Ignore/Remove the file contents from the index if the files are specified in the -x option. The <pathspec> syntax is same as the one in 'git status' parameter. Examples: 1. Add all sql files: git a *.sql 2. Add all files, but ignore all config files(ending with .config extensions) git a . -x *.config 3. Ignore multiple files(*.config, *.md) by using more than one '-x' to specify multiple patterns. git a . -x *.config -x *.md 4. Remove all config files from the index git -x *.config
git amend
The usage is:
Amend files into repository, this only amend the files that already in the index. Examples: 1. Amend without editing git amend 2. Amend, and edit the commit message, this will open the editing window, depends on what editor is configured in git. git amend -e
git b
The usage is:
Show current branch name. Example: git b
git ci
The usage is:
Commit all the indexed files into repository, same as 'git commit -m <comment>'. Example: git ci "This is the comment."
git cia
The usage is:
Add content files into index, and then create a new commit. By default it will add all the files under the current folder. You can ignore/remove files by specifying in the '-x' option. This is a combination of the following commands: 'git a . -x <pathspec>' 'git commit -m <comment>' Examples: 1. Add all files and create a commit. git cia "This is the comment" 2. Exclude *.config files, and create a commit. git -x *.config "This is the comment" 3. Exclude the *.cs and *.config files, and create a commit. git -x *.config -x *.cs "This is the comment"
git co
The usage is:
Check out the branch matching the string in <branch>. If multiple branches include the <branch> text, all those branches will be listed and let user to choose. This only works if '-b' is not present. If '-b' is present, a new branch with name <branch> will be created. Examples: Suppose we have 4 existing branches - master, develop, feature_1, feature_2 1. Switch to an existing branch 'develop' git co develop 2. Create a new branch 'feature_3' git co -b feature_3 3. Create a new branch, and set the start point with <start_point> git co -b feature_3 32aa51b 4. Switch to a branch with name like 'feature_*' gi co feature_
Notice:
You need to install git cli tool first, as all the commands will call the native git commands eventually.
Finally, happy git-ing with git-x.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for git_x-0.0.7-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f053be45776d80c7796ea956091d617a45978eff60435d7d779b902a716e056 |
|
MD5 | bc5526108ea76c78386d766c07813d47 |
|
BLAKE2b-256 | 8039b6eb78a6d7e63967891afaffe9958d7c20e88b1c403ad649d4bb0e25fd93 |