README.md

   1 # git-cola: The highly caffeinated Git GUI
   2
   3     git-cola is a powerful Git GUI with a slick and intuitive user interface.
   4
   5     Copyright (C) 2007-2020, David Aguilar and contributors
   6
   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.
  11
  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.
  16
  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/>.
  19
  20 ## SCREENSHOTS
  21
  22 Screenshots are available on the
  23 [git-cola screenshots page](https://git-cola.github.io/screenshots.html).
  24
  25 ## DOWNLOAD
  26
  27     apt install git-cola
  28
  29 New releases are available on the
  30 [git-cola download page](https://git-cola.github.io/downloads.html).
  31
  32 ## FORK
  33
  34     git clone git://github.com/git-cola/git-cola.git
  35
  36 [![git-cola build status](https://api.travis-ci.org/git-cola/git-cola.svg?branch=main)](https://travis-ci.org/git-cola/git-cola)
  37
  38 [git-cola on github](https://github.com/git-cola/git-cola)
  39
  40 [git-cola google group](https://groups.google.com/group/git-cola/)
  41
  42
  43 # NUTRITIONAL FACTS
  44
  45 ## ACTIVE INGREDIENTS
  46
  47 * [git](https://git-scm.com/) 1.6.3 or newer.
  48
  49 * [Python](https://python.org/) 2.6 or newer (Python 2+3 compatible).
  50
  51 * [QtPy](https://github.com/spyder-ide/qtpy) 1.1.0 or newer.
  52
  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.
  56
  57 * [Sphinx](http://sphinx-doc.org/) for building the documentation.
  58
  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.
  63
  64 Any of the following Python Qt libraries must be installed:
  65
  66 * [PyQt4](https://www.riverbankcomputing.com/software/pyqt/download)
  67   4.6 or newer
  68
  69 * [PyQt5](https://www.riverbankcomputing.com/software/pyqt/download5)
  70   5.2 or newer
  71
  72 * [PySide](https://github.com/PySide/PySide)
  73   1.1.0 or newer
  74
  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.
  77
  78 ## ADDITIVES
  79
  80 git-cola enables additional features when the following
  81 Python modules are installed.
  82
  83 [send2trash](https://github.com/hsoft/send2trash) enables cross-platform
  84 "Send to Trash" functionality.
  85
  86 # BREWING INSTRUCTIONS
  87
  88 ## RUN FROM SOURCE
  89
  90 You don't need to install git-cola to run it.
  91 Running git-cola from its source tree is the easiest
  92 way to try the latest version.
  93
  94     git clone git://github.com/git-cola/git-cola.git
  95     cd git-cola
  96     ./bin/git-cola
  97     ./bin/git-dag
  98
  99 Having git-cola's `bin/` directory in your path allows you to run
 100 `git cola` like a regular built-in Git command:
 101
 102     # Replace "$PWD/bin" with the path to git-cola's bin/ directory
 103     PATH="$PWD/bin":"$PATH"
 104     export PATH
 105
 106     git cola
 107     git dag
 108
 109 The instructions below assume that you have git-cola present in your
 110 `$PATH`.  Replace "git cola" with "./bin/git-cola" as needed if you'd like to
 111 just run it in-place.
 112
 113 # DOCUMENTATION
 114
 115 * [HTML documentation](https://git-cola.readthedocs.io/en/latest/)
 116
 117 * [git-cola manual](share/doc/git-cola/git-cola.rst)
 118
 119 * [git-dag manual](share/doc/git-cola/git-dag.rst)
 120
 121 * [Keyboard shortcuts](https://git-cola.github.io/share/doc/git-cola/hotkeys.html)
 122
 123 * [Contributing guidelines](CONTRIBUTING.md)
 124
 125 # INSTALLATION
 126
 127 Normally you can just do "make install" to install git-cola
 128 in your `$HOME` directory (`$HOME/bin`, `$HOME/share`, etc).
 129 If you want to do a global install you can do
 130
 131     make prefix=/usr install
 132
 133 The platform-specific installation methods below use the native
 134 package manager.  You should use one of these so that all of git-cola's
 135 dependencies are installed.
 136
 137 Distutils is used by the `Makefile` via `setup.py` to install git-cola and
 138 its launcher scripts.  distutils replaces the `#!/usr/bin/env python` lines in
 139 scripts with the full path to python at build time, which can be undesirable
 140 when the runtime python is not the same as the build-time python.  To disable
 141 the replacement of the `#!/usr/bin/env python` lines, pass `USE_ENV_PYTHON=1`
 142 to `make`.
 143
 144 ## LINUX
 145
 146 Linux is it! Your distro has probably already packaged git-cola.
 147 If not, please file a bug against your distribution ;-)
 148
 149 ### arch
 150
 151 Available in the [AUR](https://aur.archlinux.org/packages/git-cola/).
 152
 153 ### debian, ubuntu
 154
 155     apt install git-cola
 156
 157 ### fedora
 158
 159     dnf install git-cola
 160
 161 ### gentoo
 162
 163     emerge git-cola
 164
 165 ### opensuse, sle
 166
 167     zypper install git-cola
 168
 169 ### slackware
 170
 171 Available in [SlackBuilds.org](http://slackbuilds.org/result/?search=git-cola).
 172
 173 ### FreeBSD
 174
 175     # install from official binary packages
 176     pkg install -r FreeBSD devel/git-cola
 177     # build from source
 178     cd /usr/ports/devel/git-cola && make clean install
 179
 180 ## Ubuntu
 181
 182 The default version on 18.04 is older and is missing features and enhancements.
 183 Use this [PPA](https://launchpad.net/~pavreh/+archive/ubuntu/git-cola)
 184 maintained by @pavreh to get a newer version.
 185
 186 ## MAC OS X
 187
 188 [Homebrew](https://brew.sh/) is the easiest way to install
 189 git-cola's Qt4 and PyQt4 dependencies.  We will use Homebrew to install
 190 the git-cola recipe, but build our own .app bundle from source.
 191
 192 [Sphinx](http://sphinx-doc.org/latest/install.html) is used to build the
 193 documentation.
 194
 195     brew install sphinx-doc
 196     brew install git-cola
 197
 198 Once brew has installed git-cola you can:
 199
 200 1. Clone git-cola
 201
 202     `git clone git://github.com/git-cola/git-cola.git && cd git-cola`
 203
 204 2. Build the git-cola.app application bundle
 205
 206     ```
 207     make \
 208         PYTHON=$(brew --prefix python3)/bin/python3 \
 209         PYTHON_CONFIG=$(brew --prefix python3)/bin/python3-config \
 210         SPHINXBUILD=$(brew --prefix sphinx-doc)/bin/sphinx-build \
 211         git-cola.app
 212    ```
 213
 214 3. Copy it to /Applications
 215
 216     `rm -fr /Applications/git-cola.app && cp -r git-cola.app /Applications`
 217
 218 Newer versions of Homebrew install their own `python3` installation and
 219 provide the `PyQt5` modules for `python3` only.  You have to use
 220 `python3 ./bin/git-cola` when running from the source tree.
 221
 222 ### UPGRADING USING HOMEBREW
 223
 224 If you upgrade using `brew` then it is recommended that you re-install
 225 git-cola's dependencies when upgrading.  Re-installing ensures that the
 226 Python modules provided by Homebrew will be properly set up.
 227
 228 This is required when upgrading to a modern (post-10.11 El Capitan) Mac OS X.
 229 Homebrew now bundles its own Python3 installation instead of using the
 230 system-provided default Python.
 231
 232
 233     # update homebrew
 234     brew update
 235
 236     # uninstall git-cola and its dependencies
 237     brew uninstall git-cola
 238     brew uninstall pyqt5
 239     brew uninstall sip
 240
 241     # re-install git-cola and its dependencies
 242     brew install git-cola
 243
 244 ## WINDOWS INSTALLATION
 245
 246 IMPORTANT If you have a 64-bit machine, install the 64-bit versions only.
 247 Do not mix 32-bit and 64-bit versions.
 248
 249 Download and install the following:
 250
 251 * [Git for Windows](https://git-for-windows.github.io/)
 252
 253 * [Git Cola](https://github.com/git-cola/git-cola/releases)
 254
 255 Once these are installed you can run Git Cola from the Start menu.
 256
 257 See "WINDOWS (continued)" below for more details.
 258
 259 # GOODIES
 260
 261 git cola ships with an interactive rebase editor called `git-cola-sequence-editor`.
 262 `git-cola-sequence-editor` is used to reorder and choose commits when rebasing.
 263 Start an interactive rebase through the "Rebase" menu, or through the
 264 `git cola rebase` sub-command to use the `git-cola-sequence-editor`:
 265
 266     git cola rebase origin/main
 267
 268 git-cola-sequence-editor can be launched independently of git cola by telling
 269 `git rebase` to use it as its editor through the `GIT_SEQUENCE_EDITOR`
 270 enviironment variable:
 271
 272     env GIT_SEQUENCE_EDITOR="$PWD/bin/git-cola-sequence-editor" \
 273     git rebase -i origin/main
 274
 275 # COMMAND-LINE TOOLS
 276
 277 The git-cola command exposes various sub-commands that allow you to quickly
 278 launch tools that are available from within the git-cola interface.
 279 For example, `./bin/git-cola find` launches the file finder,
 280 and `./bin/git-cola grep` launches the grep tool.
 281
 282 See `git cola --help-commands` for the full list of commands.
 283
 284     $ git cola --help-commands
 285     usage: git-cola [-h]
 286
 287                     {cola,am,archive,branch,browse,config,
 288                      dag,diff,fetch,find,grep,merge,pull,push,
 289                      rebase,remote,search,stash,tag,version}
 290                     ...
 291
 292     valid commands:
 293       {cola,am,archive,branch,browse,config,
 294        dag,diff,fetch,find,grep,merge,pull,push,
 295        rebase,remote,search,stash,tag,version}
 296
 297         cola                start git-cola
 298         am                  apply patches using "git am"
 299         archive             save an archive
 300         branch              create a branch
 301         browse              browse repository
 302         config              edit configuration
 303         dag                 start git-dag
 304         diff                view diffs
 305         fetch               fetch remotes
 306         find                find files
 307         grep                grep source
 308         merge               merge branches
 309         pull                pull remote branches
 310         push                push remote branches
 311         rebase              interactive rebase
 312         remote              edit remotes
 313         search              search commits
 314         stash               stash and unstash changes
 315         tag                 create tags
 316         version             print the version
 317
 318 ## HACKING
 319
 320 The following commands should be run during development:
 321
 322     # Run the unit tests
 323     $ make test
 324
 325     # Run tests and longer-running pylint and flake8 checks
 326     $ make check
 327
 328     # Run tests against multiple python interpreters using tox
 329     $ make tox
 330
 331 The test suite can be found in the [test](test) directory.
 332
 333 The tests are set up to run automatically when code is pushed using
 334 [Travis CI](https://travis-ci.org/git-cola/git-cola).
 335 Checkout the [Travis config file](.travis.yml) for more details.
 336
 337 Auto-format `po/*.po` files before committing when updating translations:
 338
 339     $ make po
 340
 341 When submitting patches, consult the
 342 [contributing guidelines](CONTRIBUTING.md).
 343
 344 ## SOURCE INSTALL
 345
 346 For Linux/Unix-like environments with symlinks, an easy way to use the latest
 347 `git cola` is to keep a clone of the repository and symlink it into your
 348 `~/bin` directory.  If `$HOME/bin` is not already in your `$PATH` you can
 349 add these two lines to the bottom of your `~/.bashrc` to make the linked
 350 tools available.
 351
 352         PATH="$HOME/bin":"$PATH"
 353         export PATH
 354
 355 Then, install git-cola by linking it into your `~/bin`:
 356
 357         mkdir -p ~/src ~/bin
 358         git clone git://github.com/git-cola/git-cola.git ~/src/git-cola
 359         (cd ~/bin &&
 360          ln -s ../src/git-cola/bin/git-cola &&
 361          ln -s ../src/git-cola/bin/git-dag)
 362
 363 You should then get the latest `git cola` in your shell.
 364
 365
 366 ## PACKAGING NOTES
 367
 368 Git Cola installs its modules into the default Python site-packages directory
 369 (eg. `lib/python2.7/site-packages`), and in its own private `share/git-cola/lib`
 370 area by default.  The private modules are redundant and not needed when cola's modules
 371 have been installed into the site-packages directory.
 372
 373 Git Cola will prefer its private modules when the `share/git-cola/lib` directory
 374 exists, but they are not required to exist.  This directory is optional, and can
 375 be safely removed if the cola modules have been installed into site-pacakges
 376 and are importable through the default `sys.path`.
 377
 378 To suppress the installation of the private (redundant) `share/git-cola/lib/cola`
 379 package, specify `make NO_PRIVATE_LIBS=1 ...` when invoking `make`,
 380 or export `GIT_COLA_NO_PRIVATE_LIBS=1` into the build enviornment.
 381
 382     make NO_PRIVATE_LIBS=1 ...
 383
 384 Git Cola installs a vendored copy of its QtPy dependency by default.
 385 Git Cola provides a copy of the `qtpy` module in its private modules area
 386 when installing Git Cola so that you are not required to install QtPy separately.
 387 If you'd like to provide your own `qtpy` module, for example from the `python-qtpy`
 388 Debian package, then specify `make NO_VENDOR_LIBS=1 ...` when invoking `make`,
 389 or export `GIT_COLA_NO_VENDOR_LIBS=1` into the build environment.
 390
 391     make NO_VENDOR_LIBS=1 ...
 392
 393 Python3 users on debian will need to install `python3-distutils` in order
 394 to run the Makefile's installation steps.  `distutils` is a Python build
 395 requirement, but not needed at runtime.
 396
 397 # WINDOWS (continued)
 398
 399 ## Development
 400
 401 In order to develop Git Cola on Windows you will need to install
 402 Python3 and pip.  Install PyQt5 using `pip install PyQt5`
 403 to make the PyQt5 bindings available to Python.
 404
 405 Once these are installed you can use `python.exe` to run
 406 directly from the source tree.  For example, from a Git Bash terminal:
 407
 408     /c/Python36/python.exe ./bin/git-cola
 409
 410 ## Multiple Python versions
 411
 412 If you have multiple versions of Python installed, the `contrib/win32/cola`
 413 launcher script might choose the newer version instead of the python
 414 that has PyQt installed.  In order to resolve this, you can set the
 415 `cola.pythonlocation` git configuration variable to tell cola where to
 416 find python.  For example:
 417
 418     git config --global cola.pythonlocation /c/Python36
 419
 420 ## BUILDING WINDOWS INSTALLERS
 421
 422 Windows installers are built using
 423
 424 * [Pynsist](https://pynsist.readthedocs.io/en/latest/).
 425
 426 * [NSIS](http://nsis.sourceforge.net/Main_Page) is also needed.
 427
 428 To build the installer using Pynsist run:
 429
 430     ./contrib/win32/run-pynsist.sh
 431
 432 This will generate an installer in `build/nsis/`.
 433
 434 ## WINDOWS HISTORY BROWSER CONFIGURATION UPGRADE
 435
 436 You may need to configure your history browser if you are upgrading from an
 437 older version of Git Cola.
 438
 439 `gitk` was originally the default history browser, but `gitk` cannot be
 440 launched as-is on Windows because `gitk` is a shell script.
 441
 442 If you are configured to use `gitk`, then change your configuration to
 443 go through Git's `sh.exe` on Windows.  Similarly, we must go through
 444 `python.exe` if we want to use `git-dag`.
 445
 446 If you want to use gitk as your history browser open the
 447 Preferences screen and change the history browser command to:
 448
 449     "C:/Program Files/Git/bin/sh.exe" --login -i C:/Git/bin/gitk
 450
 451 git-dag became the default history browser on Windows in `v2.3`, so new
 452 users should not need to configure anything.