Guix/GuixSD development repository; official: http://git.savannah.gnu.org/cgit/guix.git
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Collin J. Doering 1eeeafb757
FIX: Add zsh-autosuggestions
2 months ago
build-aux daemon: Remove 'NIX_LIBEXEC_DIR'. 2 months ago
doc import: crate: Allow imports of a specific version. 2 months ago
etc etc: Remove references to libexec/guix* from SELinux policy. 2 months ago
gnu FIX: Add zsh-autosuggestions 2 months ago
guix import: KDE updater finds packages even in sub-directory. 2 months ago
m4 build: 'GUIX_CHECK_GUILE_JSON' really checks for Guile-JSON 3.x. 2 months ago
nix daemon: Remove 'NIX_LIBEXEC_DIR'. 2 months ago
po nls: Update 'fr' translation of the manual. 2 months ago
scripts pull: Install the new Guix in a profile. 1 year ago
tests services: openntpd: Add test for issue #3731. 2 months ago
.dir-locals.el syscalls: Add 'with-file-lock' macro. 5 months ago
.envrc Add .envrc file 2 months ago
.gitignore bootstrap: Break automake dependency on generated files. 6 months ago
.mailmap Correct email address for ison. 6 months ago
AUTHORS AUTHORS: Remove the hand-made list of people. 4 years ago
CODE-OF-CONDUCT CODE-OF-CONDUCT: Switch to version 1.4 of the Contributor Covenant. 1 year ago
COPYING Add the usual top-level files. 7 years ago
ChangeLog build: Generate a ChangeLog file upon "make dist". 6 years ago
HACKING doc: Update keyserver URL. 4 months ago
Makefile.am upstream: Move KDE updater into a separate module. 2 months ago
NEWS Update NEWS. 6 months ago
README doc: Update 'README'. 2 months ago
ROADMAP Rename 'dmd' to 'shepherd' in comments and strings. 3 years ago
THANKS Thank Thomas. 3 years ago
TODO Update 'TODO' 9 months ago
bootstrap bootstrap: Break automake dependency on generated files. 6 months ago
config-daemon.ac daemon: Run 'guix substitute' directly and assume a single substituter. 2 months ago
configure.ac maint: Switch to Guile-JSON 3.x. 3 months ago
d3.v3.js graph: Add d3js backend. 2 years ago
gnu.scm Add (gnu system keyboard). 7 months ago
graph.js graph: Add d3js backend. 2 years ago
guix.scm Add (guix monad-repl). 5 years ago

README

-*- mode: org -*-

[[https://www.gnu.org/software/guix/][GNU Guix]] (IPA: /ɡiːks/) is a purely functional package manager, and
associated free software distribution, for the [[https://www.gnu.org/gnu/gnu.html][GNU system]]. In addition
to standard package management features, Guix supports transactional
upgrades and roll-backs, unprivileged package management, per-user
profiles, and garbage collection.

It provides [[https://www.gnu.org/software/guile/][Guile]] Scheme APIs, including a high-level embedded
domain-specific languages (EDSLs) to describe how packages are to be
built and composed.

GNU Guix can be used on top of an already-installed GNU/Linux distribution, or
it can be used standalone (we call that “Guix System”).

Guix is based on the [[https://nixos.org/nix/][Nix]] package manager.


* Requirements

GNU Guix currently depends on the following packages:

- [[https://gnu.org/software/guile/][GNU Guile 2.2.x]]
- [[https://notabug.org/cwebber/guile-gcrypt][Guile-Gcrypt]] 0.1.0 or later
- [[https://www.gnu.org/software/make/][GNU Make]]
- [[https://www.gnutls.org][GnuTLS]] compiled with guile support enabled
- [[https://notabug.org/guile-sqlite3/guile-sqlite3][Guile-SQLite3]], version 0.1.0 or later
- [[https://gitlab.com/guile-git/guile-git][Guile-Git]]
- [[http://www.zlib.net/][zlib]]
- [[https://savannah.nongnu.org/projects/guile-json/][Guile-JSON]]

Unless `--disable-daemon' was passed, the following packages are needed:

- [[https://gnupg.org/][GNU libgcrypt]]
- [[https://sqlite.org/][SQLite 3]]
- [[https://gcc.gnu.org][GCC's g++]]
- optionally [[http://www.bzip.org][libbz2]]

When `--disable-daemon' was passed, you instead need the following:

- [[https://nixos.org/nix/][Nix]]

* Installation

See the manual for the installation instructions, either by running

info -f doc/guix.info "Installation"

or by checking the [[https://www.gnu.org/software/guix/manual/guix.html#Installation][web copy of the manual]].

For information on installation from a Git checkout, please see the section
"Building from Git" in the manual.

* Installing Guix from Guix

You can re-build and re-install Guix using a system that already runs Guix.
To do so:

- Start a shell with the development environment for Guix:

guix environment guix

- Re-run the 'configure' script passing it the option
'--localstatedir=/somewhere', where '/somewhere' is the 'localstatedir'
value of the currently installed Guix (failing to do that would lead the
new Guix to consider the store to be empty!).

- Run "make", "make check", and "make install".

* How It Works

Guix does the high-level preparation of a /derivation/. A derivation is
the promise of a build; it is stored as a text file under
=/gnu/store/xxx.drv=. The (guix derivations) module provides the
`derivation' primitive, as well as higher-level wrappers such as
`build-expression->derivation'.

Guix does remote procedure calls (RPCs) to the build daemon (the =guix-daemon=
command), which in turn performs builds and accesses to the store on its
behalf. The RPCs are implemented in the (guix store) module.

* Contact

GNU Guix is hosted at https://savannah.gnu.org/projects/guix/.

Please email <help-guix@gnu.org> for questions and <bug-guix@gnu.org> for bug
reports; email <gnu-system-discuss@gnu.org> for general issues regarding the
GNU system.

Join #guix on irc.freenode.net.

* Guix & Nix

GNU Guix is based on [[https://nixos.org/nix/][the Nix package manager]]. It implements the same
package deployment paradigm, and in fact it reuses some of its code.
Yet, different engineering decisions were made for Guix, as described
below.

Nix is really two things: a package build tool, implemented by a library
and daemon, and a special-purpose programming language. GNU Guix relies
on the former, but uses Scheme as a replacement for the latter.

Using Scheme instead of a specific language allows us to get all the
features and tooling that come with Guile (compiler, debugger, REPL,
Unicode, libraries, etc.) And it means that we have a general-purpose
language, on top of which we can have embedded domain-specific languages
(EDSLs), such as the one used to define packages. This broadens what
can be done in package recipes themselves, and what can be done around them.

Technically, Guix makes remote procedure calls to the ‘nix-worker’
daemon to perform operations on the store. At the lowest level, Nix
“derivations” represent promises of a build, stored in ‘.drv’ files in
the store. Guix produces such derivations, which are then interpreted
by the daemon to perform the build. Thus, Guix derivations can use
derivations produced by Nix (and vice versa).

With Nix and the [[https://nixos.org/nixpkgs][Nixpkgs]] distribution, package composition happens at
the Nix language level, but builders are usually written in Bash.
Conversely, Guix encourages the use of Scheme for both package
composition and builders. Likewise, the core functionality of Nix is
written in C++ and Perl; Guix relies on some of the original C++ code,
but exposes all the API as Scheme.

* Related software

- [[https://nixos.org][Nix, Nixpkgs, and NixOS]], functional package manager and associated
software distribution, are the inspiration of Guix
- [[https://www.gnu.org/software/stow/][GNU Stow]] builds around the idea of one directory per prefix, and a
symlink tree to create user environments
- [[https://www.pvv.ntnu.no/~arnej/store/storedoc_6.html][STORE]] shares the same idea
- [[https://live.gnome.org/OSTree/][GNOME's OSTree]] allows bootable system images to be built from a
specified set of packages
- The [[https://www.gnu.org/s/gsrc/][GNU Source Release Collection]] (GSRC) is a user-land software
distribution; unlike Guix, it relies on core tools available on the
host system