Installation

Installation

Install GitComet on macOS, Windows, or Linux using the supported distribution channel for your platform.

GitComet installation is organized by operating system so users can quickly find the distribution method that matches their environment.

Use the platform-specific package or release method first. Build-from-source steps can be documented inside the platform page where they are relevant.

Requirements

  • git 2.50 or newer must be installed on your system.

Supported platforms

GitHub Releases

You can also download the latest prebuilt binaries and installers from GitHub Releases:

Build from Source

Building from source is a universal installation path when you want the latest development version, need a local build, or your platform is not covered by the packaged install methods above.

Dependencies:

  • Rust
  • Metal SDK (macOS)
  • C++ redistributable (Windows)
git clone https://github.com/Auto-Explore/GitComet.git
cd GitComet
cargo build --release -p gitcomet --features ui-gpui,gix
cargo run -p gitcomet --features ui-gpui,gix -- /path/to/repo

Installation File Locations

Default Path of GitComet's Settings Directory

Use this section to document the default settings directory path for each supported operating system.

  • Linux
  • macOS
  • Windows

Documentation

Search

move open Esc close

Browse the docs or start typing to filter results.