Installation

This guide will get you set up and ready to use GitPig. This guide will cover getting started with macOS, Windows and Ubuntu.

macOS

Head to the releases page and download the latest version of the GitPig .dmg file for macOS.

Once downloaded, open the .dmg file and drag the GitPig app into your Applications folder.

Open GitPig, and it will prompt you to allow GitPig to access to keychain. This is used to store your GitLab access token securely. It is required to allow GitPig to access your keychain.

At this point, you application will be ready.

Windows

Head to the releases page and download the latest version of the GitPig .exe or .msi file for Windows.

Run the installer file and follow the on-screen instructions.

Open GitPig, and it will prompt you to allow GitPig to access to keychain. This is used to store your GitLab access token securely. It is required to allow GitPig to access your keychain.

At this point, you application will be ready.

.exe vs .msi

NSIS (.exe) and MSI (.msi) are two different methods of packaging and distributing software installers on Windows. They have some key differences:

NSIS (.exe) Installer:

• NSIS stands for Nullsoft Scriptable Install System. It is a script-driven installer system that allows developers to create custom installers for their applications.
• NSIS installers are typically distributed as executable (.exe) files.
• NSIS provides a high degree of flexibility and customization, allowing developers to create complex installation routines with custom dialogs and scripting.
• NSIS installers can be more compact and lightweight than MSI installers, which makes them suitable for simple or small applications.
• NSIS installers may not have built-in support for features like automatic updates or repair functionality, which are common in MSI installers.

MSI (.msi) Installer:

• MSI stands for Microsoft Installer. It is a standardized installer format developed by Microsoft.
• MSI installers are distributed as Windows Installer packages (.msi files) and are natively supported by Windows operating systems.
• MSI installers offer a set of standard features and behaviors, such as the ability to install, uninstall, and repair applications, as well as support for group policy-based deployment and administrative installations.
• MSI installers are typically created using tools like Microsoft's WiX Toolset or commercial installer authoring tools.
• MSI installers can be managed and deployed using Group Policy, System Center Configuration Manager (SCCM), and other Windows management tools.
• MSI installers are often preferred for larger and more complex applications, as they provide better support for enterprise-level deployment and management.

In summary, NSIS (.exe) installers are more flexible and customizable but may require more effort to create and lack some built-in features that are standard in MSI (.msi) installers. MSI installers are more standardized and offer better support for enterprise-level deployment and management but may have less flexibility in terms of customization. The choice between NSIS and MSI depends on the specific requirements of the software and the target audience.

Linux

Head to the releases page and download the latest version of the GitPig AppImage or .deb file.

.deb and AppImage are two different formats for packaging and distributing software on Linux. Here are the key differences between them and how to install each type of file:

.deb (Debian Package)

.deb files are a standard package format used primarily in Debian-based Linux distributions, such as Debian, Ubuntu, and their derivatives.

These packages are typically created and managed using package management tools like dpkg and apt.

To install a .deb package, you can use the dpkg command followed by the -i option and the path to the .deb file. For example:

sudo dpkg -i [gitpig-file-name].deb

After installing a .deb package, you can use apt or apt-get to resolve and install any dependencies, making it easier to manage software installations and updates.

The installation will save to git-pig.

At this point, you application will be ready. Run git-pig in the terminal to open.

AppImage

AppImage is a cross-distribution package format that aims to provide a self-contained, portable application that runs on most Linux distributions without the need for installation or system-wide changes.

AppImage files have an .AppImage extension and can be run directly by making them executable and running them.

To install an AppImage, you typically do not need to install it in the traditional sense. Instead, you make the file executable using the chmod command and then run it. For example:

chmod +x [gitpig-file-name].AppImage
./[gitpig-file-name].AppImage

AppImage files are self-contained and do not rely on system libraries, making them suitable for portable applications.

.deb vs AppImage

In summary, .deb files are distribution-specific package files primarily used in Debian-based Linux distributions, and you install them using the dpkg command. On the other hand, AppImage files are cross-distribution, self-contained application files that can be executed directly after making them executable using chmod.

The choice between these formats depends on your needs and the target distribution. .deb is more suitable for traditional system-wide software installations and management, while AppImage is more suitable for portable applications that do not require installation and can run on various Linux distributions.

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the Protocol API:

• Get started with GitPig by adding your GitLab Token
• Where you can get support or submit tickets for help
• Understand the System Tray iconography