FAQ

Frequently asked questions

Quick answers about what GitLocal is, what it does with your files, and how to get it.

What is GitLocal?

GitLocal is a free, local-first tool that opens a GitHub-style viewer for any folder or git repository on your computer. It renders Markdown, browses the file tree, and shows what changed, right in your browser, with no IDE required.

Is GitLocal free?

Yes. GitLocal is free and open source under the MIT license. There are no accounts, subscriptions, or telemetry.

Does GitLocal send my code anywhere?

No. GitLocal runs entirely on your machine. Clone, fetch, pull, and push actions go through your locally installed git only, and only when you choose to run them.

What operating systems does GitLocal support?

The npm package runs on macOS, Windows, and Linux with Node.js 22+. A native macOS app is also available in beta via Homebrew.

Install guide →

How is GitLocal different from an IDE like VS Code?

GitLocal is intentionally narrower than a full IDE. It focuses on reading, browsing, reviewing, and lightweight edits — the tasks people still do by hand when an AI agent generates most of the code — plus an integrated terminal for handing work back to that agent.

See all features →

How do I install GitLocal?

Run npm install -g gitlocal, then gitlocal . in any folder, or npx gitlocal to try it without installing. A macOS app is available via brew install --cask gitlocal after brew tap ehud-am/gitlocal.

Full install guide →

What file types can GitLocal preview?

GitLocal renders Markdown, source code with syntax highlighting, JSON, and images, plus built-in viewers for PDF, SVG, CSV, Excel (.xlsx and .xls), and PowerPoint (.pptx) files — many of which GitHub's web UI cannot render inline and offers only as a raw download.

About file previews →

How can I suggest a feature or contribute?

GitLocal is built in the open on GitHub. Share ideas and questions in Discussions, report bugs by opening an issue, or help build it by picking up an issue or proposing a change — see CONTRIBUTING.md. You don't need to write code to take part, and using an AI coding tool to write a change is welcome. Participating needs a free GitHub account; using GitLocal does not.

More ways to take part →

Something missing? Ask in Q&A.