Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/jorgeurtubiam-ship-it/Gulin_ia/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through building and running GuLiN Terminal from source on your machine. You will install the required system tools, clone the repository, initialize the project with a single command, and launch the application in development mode. If you only want a pre-built binary and do not need to modify the source, you can skip ahead to the direct-download note at the bottom of this page.
Pre-built installers for macOS, Linux, and Windows are available at gulin.dev/download. No build toolchain is required when using a pre-built release.

Prerequisites

Before cloning the repository, make sure the following tools are installed on your system.

All Platforms

1

Install Go 1.22 or later

Download and install Go from the official website:
# Verify your Go version after installing
go version
# go version go1.22.x ...
Download: go.dev/dl
2

Install Node.js 22 LTS

GuLiN’s frontend requires Node.js. The recommended version is Node.js 22 LTS.
# Verify your Node.js version after installing
node --version
# v22.x.x
Download: nodejs.org/en/download
3

Install Task (go-task)

GuLiN uses Task as its build system — a modern, YAML-based alternative to GNU Make. All build, dev, and package commands are run through task.
brew install go-task/tap/go-task
Verify the installation:
task --version

Platform-Specific Dependencies

macOS has no additional platform-specific dependencies beyond Go, Node.js, and Task. You are ready to clone and build.

Ollama (Optional — Local AI Models)

Install Ollama if you want to run AI models entirely on your own hardware — no API keys, no usage fees, and full privacy. GuLiN integrates with Ollama out of the box. Any model available in the Ollama library (Llama 3.2, Phi-3, Mistral, etc.) can be used as GuLiN’s AI backend.

Build from Source

1

Clone the repository

git clone https://github.com/gulindev/gulin.git
cd gulin
2

Initialize the project

Run the init task to install all Node.js and Go dependencies in one step. This only needs to be done once after cloning (or whenever you run into dependency issues).
task init
This command runs npm install, go mod tidy, and installs docs dependencies. The first run may take several minutes while Go and npm download their respective libraries.
3

Launch in development mode

Start GuLiN via the Vite development server with Hot Module Reloading enabled:
task dev
This builds the Go backend, compiles the Electron frontend, and opens the GuLiN Terminal window. Press Ctrl+C in the terminal to stop the application.
4

(Optional) Run as a standalone build

To build and run the app without the Vite dev server — closer to a production experience — use:
task start
5

(Optional) Package for distribution

To produce a production build and generate distributable installers (.dmg, .exe, .deb, .snap, etc.), run:
task package
All output artifacts are placed in the make/ directory.

Debugging

Frontend

Open Chrome DevTools inside the running GuLiN window:
  • macOS: Cmd+Option+I
  • Linux / Windows: Ctrl+Option+I

Backend

Backend logs for the development build are written to:
~/.gulin-dev/gulinapp.log
Both the Electron (Node.js) and Go backends log to this file.

Build docs developers (and LLMs) love