Skip to content
Get packs

Guide · Open source

How to use ungit: install, run and get started

Updated · written with AI from the project's own documentation and checked against our catalogue data

Ungit is a graphical user interface for git that runs as a local web server and is used from your browser. This guide shows you how to install it with npm, start it, and set it up with a configuration file. It is aimed at developers who know git basics and at beginners who want to see what git is doing.

ungitFredrikNoren/ungit · ★ 10.6k · MIT

Quick start

  1. 1Check versions. Confirm Node.js is 20.19.0 or newer, npm is 10.8.2 or newer, and git is 2.34.x or newer.
  2. 2Install ungit. Run npm install -g ungit. If your system needs root for global npm installs, use sudo -H npm install -g ungit.
  3. 3Launch ungit. Type ungit in a terminal. It starts the server and opens the interface in your browser.
  4. 4Open a repository. Use the browser interface to work with your git repositories visually.
  5. 5Optionally set a config file. Create .ungitrc in your home directory with JSON settings, such as a different port.

Check the prerequisites before you install ungit

Ungit needs Node.js, npm and git. The README asks for Node.js 20.19.0 or newer, npm 10.8.2 or newer (npm comes with Node.js), and git 2.34.x or newer.

  • Node.js 20.19.0 or newer
  • npm 10.8.2 or newer, included with Node.js
  • git 2.34.x or newer

Install ungit with npm

Install ungit globally with npm. The README gives this single command.

If your system requires root access to install global npm packages, the README says to use the -H flag with sudo.

npm install -g ungit sudo -H npm install -g ungit

Start ungit and open the interface

Run ungit from any directory. According to the README, this launches the server and opens a browser with the ui. The README also notes that ungit can run on a remote or cloud machine, where you browse to its address from your own browser, for example on port 8448.

ungit

Change settings with a config file or command-line flags

You can put a JSON file called .ungitrc in your home directory. The README gives the home paths as /home/USERNAME on Linux and similar systems, and C:/Users/USERNAME/ on Windows. For the list of available options, the README points to source/config.js.

You can also override settings at launch with command-line arguments. To turn a boolean feature off, use --no before the name.

  • Config file: .ungitrc in your home directory, written in JSON
  • Override at launch: ungit --port=8080
  • Disable a boolean feature: ungit --no-autoFetch
{ "port": 8080, "bugtracking": true }

Know how auto refresh and merge tools work

When you open a page, ungit watches the git directory recursively and refreshes its contents after git operations or changes to files. Files listed in .gitignore are not watched.

If you want a different merge tool, such as Kaleidoscope or p4merge, the README says you can configure ungit to use it. See MERGETOOL.md in the project for details.

Understand the known limits

The README says ungit does not support GPG authentication. Its PGP section explains that you can enable commit signing with git config and suggests password-less GPG setups instead.

The README also warns that ungit parses git output in English, so a non-English git setup may behave unexpectedly. Known issues include Debian Wheezy, where packaged git and Node.js are too old and must be built from source.

  • GPG authentication is not supported; the README suggests password-less gpg setups.
  • Set git to English output if you can, because ungit parses English git results.
  • Some ad blockers may block ungit's localhost calls; the README says to whitelist localhost or 127.0.0.1 with the ungit port.
git config --global commit.gpgsign true

What people use it for

  • Reviewing branches and commit history visually instead of typing many git log and branch commands.
  • Learning git by watching the graphical view update as you commit and branch.
  • Using git in a browser on a remote or cloud machine you reach over the network.
  • Working with GitHub repositories, which the README says ungit works well with.

Frequently asked questions

Is ungit free to use?

Ungit is released under the MIT licence, according to the README and its licence section. The README does not list any prices, so check the LICENSE.md file in the project for the full terms.

What do I need to run ungit?

The README lists Node.js 20.19.0 or newer, npm 10.8.2 or newer, and git 2.34.x or newer. It also says ungit runs on any platform that Node.js and git support.

How do I install ungit?

Run npm install -g ungit. If your system needs root for global npm installs, the README suggests using sudo -H npm install -g ungit.

Does ungit support GPG signing?

The README says ungit can use PGP signing when git is set to sign commits, but it does not support GPG authentication. It suggests password-less GPG setups as workarounds.

Why does ungit behave strangely with my language settings?

The README warns that ungit parses git command output written in English to detect repository states. If git uses another language, results can be confusing, so an English git setup is safer.

Can I use ungit on a remote server?

Yes. The README says ungit is web-based, so you can run it on a cloud or shell-only machine and open its interface in your browser.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Ungit suits developers who find the git command line slow, and beginners who want to see what git is doing, especially on a remote machine or with GitHub. Pick something else if you need GPG authentication, work in a non-English git setup, or run on very old systems like Debian Wheezy. Comparable projects named in our analysis include GitKraken, Sourcetree, GitHub Desktop and gitg.

Install options & downloads