1 # git-cola: The highly caffeinated Git GUI
3 git-cola is a powerful Git GUI with a slick and intuitive user interface.
5 Copyright (C) 2007-2018, David Aguilar and contributors
7 This program is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 Screenshots are available on the
23 [git-cola screenshots page](https://git-cola.github.io/screenshots.html).
27 apt-get install git-cola
29 New releases are available on the
30 [git-cola download page](https://git-cola.github.io/downloads.html).
34 git clone git://github.com/git-cola/git-cola.git
36 [![git-cola build status](https://api.travis-ci.org/git-cola/git-cola.svg?branch=master)](https://travis-ci.org/git-cola/git-cola)
38 [git-cola on github](https://github.com/git-cola/git-cola)
40 [git-cola google group](https://groups.google.com/group/git-cola/)
47 * [git](https://git-scm.com/) 1.6.3 or newer.
49 * [Python](https://python.org/) 2.6 or newer (Python 2+3 compatible).
51 * [QtPy](https://github.com/spyder-ide/qtpy) 1.1.0 or newer.
53 * [argparse](https://pypi.python.org/pypi/argparse) 1.1 or newer.
54 argparse is part of the stdlib in Python 2.7; install argparse separately if
55 you are running on Python 2.6.
57 * [Sphinx](http://sphinx-doc.org/) for building the documentation.
59 *git-cola* uses *QtPy*, so you can choose between *PyQt4*, *PyQt5*, and
60 *PySide* by setting the `QT_API` environment variable to `pyqt4`, `pyqt5` or
61 `pyside` as desired. `qtpy` defaults to `pyqt5` and falls back to `pyqt4`
62 if `pyqt5` is not installed.
64 Any of the following Python Qt libraries must be installed:
66 * [PyQt4](https://www.riverbankcomputing.com/software/pyqt/download)
69 * [PyQt5](https://www.riverbankcomputing.com/software/pyqt/download5)
72 * [PySide](https://github.com/PySide/PySide)
75 Set `QT_API=pyqt4` in your environment if you have both
76 versions of *PyQt* installed and want to ensure that PyQt4 is used.
78 *NOTE*: *git-cola* includes a vendored copy of its *QtPy* dependency.
80 We provide a copy of the `qtpy` module when installing *git-cola* so that you
81 are not required to install *QtPy* separately. If you'd like to provide your
82 own `qtpy` module, for example from the `python-qtpy` Debian package, then use
83 `make NO_VENDOR_LIBS=1 ...` when invoking `make`, or export
84 `GIT_COLA_NO_VENDOR_LIBS=1` into the build environment.
86 Python3 users on debian will need to install `python3-distutils` in order
87 to run the Makefile's installation steps. `distutils` is a Python build
88 requirement, but not needed at runtime.
93 *git-cola* enables additional features when the following
94 Python modules are installed.
96 [send2trash](https://github.com/hsoft/send2trash) enables cross-platform
97 "Send to Trash" functionality.
99 # BREWING INSTRUCTIONS
103 You don't need to install *git-cola* to run it.
104 Running *git-cola* from its source tree is the easiest
105 way to try the latest version.
107 git clone git://github.com/git-cola/git-cola.git
112 Having *git-cola*'s *bin/* directory in your path allows you to run
113 *git cola* like a regular built-in Git command:
115 # Replace "$PWD/bin" with the path to git-cola's bin/ directory
116 PATH="$PWD/bin":"$PATH"
122 The instructions below assume that you have *git-cola* present in your
123 `$PATH`. Replace "git cola" with "./bin/git-cola" as needed if you'd like to
124 just run it in-place.
128 * [HTML documentation](https://git-cola.readthedocs.io/en/latest/)
130 * [git-cola manual](share/doc/git-cola/git-cola.rst)
132 * [git-dag manual](share/doc/git-cola/git-dag.rst)
134 * [Keyboard shortcuts](https://git-cola.github.io/share/doc/git-cola/hotkeys.html)
136 * [Contributing guidelines](CONTRIBUTING.md)
140 Normally you can just do "make install" to install *git-cola*
141 in your `$HOME` directory (`$HOME/bin`, `$HOME/share`, etc).
142 If you want to do a global install you can do
144 make prefix=/usr install
146 The platform-specific installation methods below use the native
147 package manager. You should use one of these so that all of *git-cola*'s
148 dependencies are installed.
150 Distutils is used by the `Makefile` via `setup.py` to install *git-cola* and
151 its launcher scripts. distutils replaces the `#!/usr/bin/env python` lines in
152 scripts with the full path to python at build time, which can be undesirable
153 when the runtime python is not the same as the build-time python. To disable
154 the replacement of the `#!/usr/bin/env python` lines, pass `USE_ENV_PYTHON=1`
159 Linux is it! Your distro has probably already packaged git-cola.
160 If not, please file a bug against your distribution ;-)
164 Available in the [AUR](https://aur.archlinux.org/packages/git-cola/).
168 apt-get install git-cola
180 The default version on 18.04 is older and is missing features and enhancements.
181 Use this [PPA](https://launchpad.net/~pavreh/+archive/ubuntu/git-cola)
182 maintained by @pavreh to get a newer version.
186 [Homebrew](https://brew.sh/) is the easiest way to install
187 git-cola's *Qt4* and *PyQt4* dependencies. We will use Homebrew to install
188 the git-cola recipe, but build our own .app bundle from source.
190 [Sphinx](http://sphinx-doc.org/latest/install.html) is used to build the
193 brew install sphinx-doc
194 brew install git-cola
196 Once brew has installed git-cola you can:
200 `git clone git://github.com/git-cola/git-cola.git && cd git-cola`
202 2. Build the git-cola.app application bundle
206 PYTHON=$(brew --prefix python3)/bin/python3 \
207 PYTHON_CONFIG=$(brew --prefix python3)/bin/python3-config \
208 SPHINXBUILD=$(brew --prefix sphinx-doc)/bin/sphinx-build \
212 3. Copy it to _/Applications_
214 `rm -fr /Applications/git-cola.app && cp -r git-cola.app /Applications`
216 Newer versions of Homebrew install their own `python3` installation and
217 provide the `PyQt5` modules for `python3` only. You have to use
218 `python3 ./bin/git-cola` when running from the source tree.
220 ### UPGRADING USING HOMEBREW
222 If you upgrade using `brew` then it is recommended that you re-install
223 *git-cola*'s dependencies when upgrading. Re-installing ensures that the
224 Python modules provided by Homebrew will be properly setup.
226 This is required when upgrading to a modern (post-10.11 El Capitan) Mac OS X.
227 Homebrew now bundles its own Python3 installation instead of using the
228 system-provided default Python.
234 # uninstall git-cola and its dependencies
235 brew uninstall git-cola
239 # re-install git-cola and its dependencies
240 brew install git-cola
242 ## WINDOWS INSTALLATION
244 **IMPORTANT** If you have a 64-bit machine, install the 64-bit versions only.
245 Do not mix 32-bit and 64-bit versions.
247 Download and install the following:
249 * [Git for Windows](https://git-for-windows.github.io/)
251 * [Git Cola](https://github.com/git-cola/git-cola/releases)
253 Once these are installed you can run *git cola* from the Start menu.
255 See "WINDOWS (continued)" below for more details.
259 *git-cola* ships with an interactive rebase editor called *git-xbase*.
260 *git-xbase* can be used to reorder and choose commits and is typically
261 launched through the *git-cola*'s "Rebase" menu.
263 *git-xbase* can also be launched independently of the main *git-cola* interface
264 by telling `git rebase` to use it as its editor:
266 env GIT_SEQUENCE_EDITOR="$PWD/share/git-cola/bin/git-xbase" \
267 git rebase -i origin/master
269 The quickest way to launch *git-xbase* is via the *git cola rebase*
270 sub-command (as well as various other sub-commands):
272 git cola rebase origin/master
276 The *git-cola* command exposes various sub-commands that allow you to quickly
277 launch tools that are available from within the *git-cola* interface.
278 For example, `./bin/git-cola find` launches the file finder,
279 and `./bin/git-cola grep` launches the grep tool.
281 See `git cola --help-commands` for the full list of commands.
283 $ git cola --help-commands
286 {cola,am,archive,branch,browse,config,
287 dag,diff,fetch,find,grep,merge,pull,push,
288 rebase,remote,search,stash,tag,version}
292 {cola,am,archive,branch,browse,config,
293 dag,diff,fetch,find,grep,merge,pull,push,
294 rebase,remote,search,stash,tag,version}
297 am apply patches using "git am"
298 archive save an archive
299 branch create a branch
300 browse browse repository
301 config edit configuration
308 pull pull remote branches
309 push push remote branches
310 rebase interactive rebase
312 search search commits
313 stash stash and unstash changes
315 version print the version
319 The following commands should be run during development:
324 # Run tests and longer-running pylint and flake8 checks
327 # Run tests against multiple python interpretors using tox
330 The test suite can be found in the [test](test) directory.
332 The tests are setup to run automatically when code is pushed using
333 [Travis CI](https://travis-ci.org/git-cola/git-cola).
334 Checkout the [Travis config file](.travis.yml) for more details.
336 Auto-format `po/*.po` files before committing when updating translations:
340 When submitting patches, consult the
341 [contributing guidelines](CONTRIBUTING.md).
343 # WINDOWS (continued)
347 In order to develop *git cola* on Windows you will need to install
348 Python3 and pip. Install PyQt5 using `pip install PyQt5`
349 to make the PyQt5 bindings available to Python.
351 Once these are installed you can use `python.exe` to run
352 directly from the source tree. For example, from a Git Bash terminal:
354 /c/Python36/python.exe ./bin/git-cola
356 ## Multiple Python versions
358 If you have multiple versions of Python installed, the `contrib/win32/cola`
359 launcher script might choose the newer version instead of the python
360 that has PyQt installed. In order to resolve this, you can set the
361 `cola.pythonlocation` git configuration variable to tell cola where to
362 find python. For example:
364 git config --global cola.pythonlocation /c/Python36
366 ## BUILDING WINDOWS INSTALLERS
368 Windows installers are built using
370 * [Pynsist](https://pynsist.readthedocs.io/en/latest/).
372 * [NSIS](http://nsis.sourceforge.net/Main_Page) is also needed.
374 To build the installer using *Pynsist* run:
376 ./contrib/win32/run-pynsist.sh
378 This will generate an installer in `build/nsis/`.
380 ## WINDOWS HISTORY BROWSER CONFIGURATION UPGRADE
382 You may need to configure your history browser if you are upgrading from an
383 older version of *git-cola*.
385 `gitk` was originally the default history browser, but `gitk` cannot be
386 launched as-is on Windows because `gitk` is a shell script.
388 If you are configured to use `gitk`, then change your configuration to
389 go through Git's `sh.exe` on Windows. Similarly,we must go through
390 `python.exe` if we want to use `git-dag`.
392 If you want to use *gitk* as your history browser open the
393 *Preferences* screen and change the history browser command to:
395 "C:/Program Files/Git/bin/sh.exe" --login -i C:/Git/bin/gitk
397 *git-dag* became the default history browser on Windows in `v2.3`, so new
398 users should not need to configure anything.