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-2016, 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](http://groups.google.com/group/git-cola/)
48 * [git](http://git-scm.com/) 1.6.3 or newer.
50 * [Python](http://python.org/) 2.6, 2.7, and 3.2 or newer.
52 * [PyQt4](http://www.riverbankcomputing.co.uk/software/pyqt/download) 4.4 or newer
54 * [argparse](https://pypi.python.org/pypi/argparse) 1.1 or newer.
55 argparse is part of the stdlib in Python 2.7; install argparse separately if
56 you are running on Python 2.6.
58 * [Sphinx](http://sphinx-doc.org/) for building the documentation.
62 *git-cola* enables additional features when the following
63 Python modules are installed.
65 [send2trash](https://github.com/hsoft/send2trash) enables cross-platform
66 "Send to Trash" functionality.
68 # BREWING INSTRUCTIONS
72 You don't need to install *git-cola* to run it.
73 Running *git-cola* from its source tree is the easiest
74 way to try the latest version.
76 git clone git://github.com/git-cola/git-cola.git
81 Having *git-cola*'s *bin/* directory in your path allows you to run
82 *git cola* like a regular built-in Git command:
84 # Replace "$PWD/bin" with the path to git-cola's bin/ directory
85 PATH="$PWD/bin":"$PATH"
91 The instructions below assume that you have *git-cola* present in your
92 `$PATH`. Replace "git cola" with "./bin/git-cola" as needed if you'd like to
97 Normally you can just do "make install" to install *git-cola*
98 in your `$HOME` directory (`$HOME/bin`, `$HOME/share`, etc).
99 If you want to do a global install you can do
101 make prefix=/usr install
103 There are also platform-specific installation methods.
104 You'll probably want to use one of these anyways since they
105 have a nice side-effect of installing *git-cola*'s PyQt4
106 and argparse dependencies.
110 Linux is it! Your distro has probably already packaged git-cola.
111 If not, please file a bug against your distribution ;-)
119 apt-get install git-cola
131 Use the [one-click install link](http://software.opensuse.org/package/git-cola).
135 Before setting up homebrew, use
136 [pip](https://pip.readthedocs.io/en/latest/installing.html) to install
137 [sphinx](http://sphinx-doc.org/latest/install.html).
139 Sphinx is used to build the documentation.
141 sudo pip install sphinx
143 [Homebrew](http://mxcl.github.com/homebrew/) is the easiest way to install
144 git-cola's *Qt4* and *PyQt4* dependencies. We will use homebrew to install
145 the git-cola recipe, but build our own .app bundle from source.
147 brew install git-cola
149 Once brew has installed git-cola you can:
153 `git clone git://github.com/git-cola/git-cola.git && cd git-cola`
155 2. Build the git-cola.app application bundle
159 3. Copy it to _/Applications_
161 `rm -fr /Applications/git-cola.app && cp -r git-cola.app /Applications`
163 ## WINDOWS INSTALLATION
165 Download the latest stable Git, Python 2.x, and Py2x-PyQt4 installers
167 * [msysGit](http://msysgit.github.com/)
169 * [Python](http://python.org/download/)
171 * [PyQt](http://www.riverbankcomputing.co.uk/software/pyqt/download/)
173 * [git-cola Installer](https://github.com/git-cola/git-cola/downloads)
175 Once these are installed you can run *git-cola* from the Start menu or
176 by double-clicking on the `git-cola.pyw` script.
178 If you are developing *git-cola* on Windows you can use `python.exe` to run
179 *git-cola* directly from source.
181 python.exe ./bin/git-cola
183 See "WINDOWS (continued)" below for more details.
187 * [HTML documentation](https://git-cola.readthedocs.io/en/latest/)
189 * [git-cola manual](share/doc/git-cola/git-cola.rst)
191 * [git-dag manual](share/doc/git-cola/git-dag.rst)
193 * [Keyboard shortcuts](https://git-cola.github.io/share/doc/git-cola/hotkeys.html)
195 * [Contributing guidelines](CONTRIBUTING.md)
199 *git-cola* ships with an interactive rebase editor called *git-xbase*.
200 *git-xbase* can be used to reorder and choose commits and is typically
201 launched through the *git-cola*'s "Rebase" menu.
203 *git-xbase* can also be launched independently of the main *git-cola* interface
204 by telling `git rebase` to use it as its editor:
206 env GIT_SEQUENCE_EDITOR="$PWD/share/git-cola/bin/git-xbase" \
207 git rebase -i origin/master
209 The quickest way to launch *git-xbase* is via the *git cola rebase*
210 sub-command (as well as various other sub-commands):
212 git cola rebase origin/master
216 The *git-cola* command exposes various sub-commands that allow you to quickly
217 launch tools that are available from within the *git-cola* interface.
218 For example, `./bin/git-cola find` launches the file finder,
219 and `./bin/git-cola grep` launches the grep tool.
221 See `git cola --help-commands` for the full list of commands.
223 $ git cola --help-commands
226 {cola,am,archive,branch,browse,classic,config,
227 dag,diff,fetch,find,grep,merge,pull,push,
228 rebase,remote,search,stash,tag,version}
232 {cola,am,archive,branch,browse,classic,config,
233 dag,diff,fetch,find,grep,merge,pull,push,
234 rebase,remote,search,stash,tag,version}
237 am apply patches using "git am"
238 archive save an archive
239 branch create a branch
240 browse browse repository
241 classic browse repository
242 config edit configuration
249 pull pull remote branches
250 push push remote branches
251 rebase interactive rebase
253 search search commits
254 stash stash and unstash changes
256 version print the version
260 The following commands should be run during development:
265 # Check for pylint warnings. All new code must pass 100%.
268 The test suite can be found in the [test](test) directory.
270 The tests are setup to run automatically when code is pushed using
271 [Travis CI](https://travis-ci.org/git-cola/git-cola).
272 Checkout the [Travis config file](.travis.yml) for more details.
274 When submitting patches, consult the [contributing guidelines](CONTRIBUTING.md).
276 ## WINDOWS (continued)
278 # WINDOWS-ONLY HISTORY BROWSER CONFIGURATION UPGRADE
280 You may need to configure your history browser if you are upgrading from an
281 older version of *git-cola*.
283 `gitk` was originally the default history browser, but `gitk` cannot be
284 launched as-is on Windows because `gitk` is a shell script.
286 If you are configured to use `gitk`, then change your configuration to
287 go through Git's `sh.exe` on Windows. Similarly,we must go through
288 `python.exe` if we want to use `git-dag`.
290 If you want to use *gitk* as your history browser open the
291 *Preferences* screen and change the history browser command to:
293 C:/Git/bin/sh.exe --login -i C:/Git/bin/gitk
295 Alternatively, if you'd like to use *git-dag* as your history browser, use:
297 C:/Python27/python.exe C:/git-cola/bin/git-dag
299 *git-dag* became the default history browser on Windows in `v2.3`, so new
300 users should not need to configure anything.
302 # BUILDING WINDOWS INSTALLERS
304 Windows installers are built using
305 [Pynsist](http://pynsist.readthedocs.io/en/latest/).
306 [NSIS](http://nsis.sourceforge.net/Main_Page) is also needed.
308 To build the installer using *Pynsist*:
310 1. (If building from a non-Windows platform), run
311 `./contrib/win32/fetch_pyqt_windows.sh`.
312 This will download a PyQt binary installer for Windows and unpack its files
313 into `pynsist_pkgs/`.
314 2. Run `pynsist pynsist.cfg`.
315 The installer will be built in `build/nsis/`.
318 Before *Pynsist*, installers were built using *InnoSetup*.
319 The *InnoSetup* scripts are still available:
321 ./contrib/win32/create-installer.sh
323 You have to make sure that the file */share/InnoSetup/ISCC.exe* exists.
324 That is normally the case when you run the *msysGit bash* and not the
325 *Git for Windows bash* (look [here](http://msysgit.github.com/)
326 for the differences).