gf-core/download/index.md

---

title: Grammatical Framework Download and Installation ...

GF Bundle 18-12 was released on 28 November 2018.
It contains GF v3.10 and RGL snapshot 18-11-28.

What's new? See the release notes.

Binary packages ("bundles")

Platform	Download	Features	How to install
macOS	gf-18-12.pkg	GF,S,C,J,P	Double-click on the package icon
macOS	gf-18-12-bin-intel-mac.tar.gz	GF,S,C,J,P	sudo tar -C /usr/local -zxf gf-18-12-bin-intel-mac.tar.gz
Raspian 9.1	gf_18-12-1_armhf.deb	GF,S,C,J,P	sudo dpkg -i gf_18-12-1_armhf.deb
Ubuntu (32-bit)	gf_18-12-1_i386.deb	GF,S,C,J,P	sudo dpkg -i gf_18-12-1_i386.deb
Ubuntu (64-bit)	gf_18-12-1_amd64.deb	GF,S,C,J,P	sudo dpkg -i gf_18-12-1_amd64.deb
Windows	gf-18-12-bin-windows.zip	GF,S	unzip gf-18-12-bin-windows.zip

Features

• GF = GF shell and grammar compiler
• RGL = Resource Grammar Library
• S = gf -server mode
• C = C run-time system
• J/P = Java/Python binding to the C run-time system

Notes

The Windows package is installed by just unpacking it anywhere. You will probably need to set the PATH and GF_LIB_PATH environment variables, see Inari's notes on Installing GF on Windows.

The Ubuntu .deb packages should work on Ubuntu 16.04 and 17.04 and similar Linux distributions.

The Raspian .deb package was created on a Raspberry Pi 3 and will probably work on other ARM-based systems running Debian 9 (stretch) or similar Linux distributions.

The packages for macOS (Mac OS X) should work on at least 10.11 and 10.12 (El Capitan and Sierra).

The Mac OS and Linux .tar.gz packages are designed to be installed in /usr/local. You can install them in other locations, but then you need to set the GF_LIB_PATH environment variable:

export GF_LIB_PATH=/usr/local/share/gf-3.9/lib

where /usr/local should be replaced with the path to the location where you unpacked the package.

Installing the latest release from source

GF is on Hackage, so under normal circumstances the prodedure is fairly simple:

1. Install a recent version of the Haskell Platform, e.g. version 7.10.3 (see note 2 below)
2. cabal update
3. On Linux: install some C libraries from your Linux distribution (see note 1 below)
4. cabal install gf

You can also download full source packages from GitHub:

• GF releases
• RGL releases

Notes

Installation location

The above steps installs GF for a single user. The executables are put in $HOME/.cabal/bin (or, with recent versions of the Haskell platform on Mac OS X, in $HOME/Library/Haskell/bin), so it is a good idea to put a line in your .bash_profile or .profile to add that directory to you path:

PATH=$HOME/.cabal/bin:$PATH

or

PATH=$HOME/Library/Haskell/bin:$PATH

Build tools

TODO Alex, Happy

Haskeline

GF uses haskeline, which on Linux depends on some non-Haskell libraries that won't be installed automatically by cabal, and therefore need to be installed manually. Here is one way to do this:

• On Ubuntu: sudo apt-get install libghc-haskeline-dev
• On Fedora: sudo yum install ghc-haskeline-devel

GHC version

The GF source code has been updated to compile with GHC 8.2.1. Using older versions of GHC (e.g. 8.0.x and 7.10.3) should still work too.

Installing from the latest developer source code

The first time:

git clone https://github.com/GrammaticalFramework/gf-core.git
cd gf-core
cabal install

and

git clone https://github.com/GrammaticalFramework/gf-rgl.git
cd gf-rgl
make

Subsequently:

cd gf-core
git pull
cabal install

and

cd gf-rgl
git pull
make

The above notes for installing from source apply also in these cases. For more info on working with the GF source code, see the GF Developers Guide.

Older releases

• GF 3.9 (August 2017)
• GF 3.8 (June 2016)
• GF 3.7.1 (October 2015)
• GF 3.7 (June 2015)
• GF 3.6 (June 2014)
• GF 3.5 (August 2013)
• GF 3.4 (January 2013)
• GF 3.3.3 (March 2012)
• GF 3.3 (October 2011)
• GF 3.2.9 source-only snapshot (September 2011)
• GF 3.2 (December 2010)
• GF 3.1.6 (April 2010)