diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 40 |
1 files changed, 6 insertions, 34 deletions
@@ -1,15 +1,15 @@ [](https://travis-ci.com/isacikgoz/gitbatch) [](/LICENSE) [](https://goreportcard.com/report/github.com/isacikgoz/gitbatch) ## gitbatch -Aim of this tool to make your local repositories synchronized with remotes easily. Inspired from lazygit and I build this according to my needs; Since my daily work is tied to many repositories I often end up walking on many directories and manually pulling updates etc. To make this routine faster, I created a simple tool to handle this job. I really enjoy working on this project and I hope it will be a useful tool. +Aim of this tool to make your local repositories synchronized with remotes easily. I inspired from lazygit and decided to build this project for my needs; Since my daily work is tied to many repositories I often end up walking on many directories and manually pulling updates etc. To make this routine faster, I created a simple tool to handle this job. I really enjoy working on this project and I hope it will be a useful tool. **Disclaimer** - Authentication required repositories are **not supported** using ssh is recommended if you need to authenticate to fetch/pull - [Connecting to GitHub with SSH](https://help.github.com/articles/connecting-to-github-with-ssh/) - [GitLab and SSH keys](https://docs.gitlab.com/ee/ssh/) - [BitBucket Set up an SSH key](https://confluence.atlassian.com/bitbucket/set-up-ssh-for-git-728138079.html) -- Some strange behavior is expected and feedbacks are welcome. For now, known issues are: - - At very low probability app fails to load repositories, try again it will open next time (multithreading problem) +- Feedbacks are welcome. For now, known issues are: + - At very low probability app fails to load repositories, try again it will load next time (multithreading problem) - Sometimes when you scroll too fast while pulling/fetching/merging, some multithreading problem occurs and app crashes (will fix soon) - colors vary to your terminal theme colors, so if the contrast is not enough on some color decisions; discussions are welcome @@ -36,43 +36,15 @@ run the `gitbatch` command from the parent of your git repositories. For start-u ### Controls -- **tab**: Switch mode -- **↑** or **k**: Up -- **↓** or **j**: Down -- **b**: Iterate over branches -- **r**: Iterate over remotes -- **e**: Iterate over remote branches -- **s**: Iterate over commits -- **d**: Show commit diff -- **c**: Controls or close windows if a pop-up window opened -- **enter**: Start queue -- **space**: Add to queue -- **ctrl + c**: Force application to quit -- **q**: Quit +Please see [Controls page](https://github.com/isacikgoz/gitbatch/wiki/Controls) ### Modes -- **FETCH**: fetches the selected **remote** e.g. *Origin*, *Upstream*, etc. -- **PULL**: fetches the selected **remote** and merges selected **remote branch** into **active branch** e.g. origin/master → master -- **MERGE**: merges the selected **remote branch** into **active branch** e.g. origin/master → master +Please see [Modes page](https://github.com/isacikgoz/gitbatch/wiki/Modes) ### Display -#### Repository Screen -↖ 0 ↘ 0 → master ✗ ips.server.slave.native • -↖ (pushables) ↘ (pullables) → (branch) (✗ if dirty) (repository folder name) (• if queued) - -- if pushables or pullables appear to be "**?**", that means no upstream configured for the active branch - - to resolve this issue; - 1. change directory the repository and checkout to the branch prints **?** on upstream - 2. make sure remote is set by running `git remote -v` - 3. run `git config --local --add branch.<your branch name>.remote=<your remote name>` - 4. run `git config --local --add branch.<your branch name>.merge=refs/heads/<your branch name>` -- the queued indicator color represents the operation same as mode color - -#### Commit Screen -- if hash color is cyan it means that commit is a local commit, if yellow it means it is a commit that will merge in to your active branch if you pull or merge -- you can see the diff by simply pressing **d** on the selected commit +Please see [Display page](https://github.com/isacikgoz/gitbatch/wiki/Display) ## Further goals - add testing |