whatisgithub

What is nix-emacs?

syl20bnr/nix-emacs — explained in plain English

Analysis updated 2026-07-18 · repo last pushed 2015-07-26

Emacs LispAudience · developerComplexity · 1/5DormantSetup · easy

In one sentence

An Emacs toolkit that adds searchable option lookup and autocomplete for Nix configuration files, so NixOS users get IDE-like help without leaving the editor.

Mindmap

mindmap
  root((nix-emacs))
    What it does
      Searches Nix options
      Shows inline docs
      Autocompletes as you type
    Tech stack
      Emacs Lisp
      Helm
      Company mode
    Use cases
      Write NixOS configs faster
      Learn Nix options
      Avoid syntax typos
    Audience
      NixOS users
      Emacs users
      Nix beginners
    Features
      helm-nixos-options search
      company-mode popups

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Search all available Nix options with inline descriptions using a keyboard shortcut in Emacs.

USE CASE 2

Get autocomplete suggestions and hover documentation while writing Nix configuration files.

USE CASE 3

Learn the Nix ecosystem's many options without switching to a browser to check the manual.

What is it built with?

Emacs LispHelmcompany-mode

How does it compare?

syl20bnr/nix-emacsidanov/bulgarian-holidays.eljxs/editorconfig-emacs
LanguageEmacs LispEmacs LispEmacs Lisp
Last pushed2015-07-262020-12-282017-09-12
MaintenanceDormantDormantDormant
Setup difficultyeasyeasyeasy
Complexity1/51/52/5
Audiencedeveloperdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Requires Emacs with helm and company-mode already installed and configured.

So what is it?

This is a toolkit that makes writing Nix configuration files easier inside Emacs, a popular text editor. If you're setting up a NixOS system or writing Nix code, this project gives you smart autocomplete and documentation lookup right in your editor, similar to how modern IDEs help you write code faster. The project provides two main features. The first is a search tool called helm-nixos-options, which you can trigger with a keyboard shortcut. When you press it, you get a searchable list of all available Nix options with their descriptions shown inline. If you want the full documentation for an option, you can open a detailed buffer with more information. The second feature integrates with company-mode, Emacs's autocomplete system, so you get instant suggestions as you type, and hovering over an option shows its documentation in a popup. Both tools help you avoid typos and remember syntax without having to look things up in external documentation. People who use NixOS, a Linux distribution that manages system configuration declaratively, or anyone writing Nix configuration files would find this useful. Instead of constantly switching to a web browser or manual to check option names and their correct format, you can stay in your editor and get immediate feedback. This is especially helpful for beginners learning the Nix ecosystem, since there are many options to remember, and for experienced users who want to work faster. The README doesn't go into detail about the underlying architecture, but the project is written in Emacs Lisp, the scripting language for Emacs, so it integrates seamlessly with your editor. If you use Emacs and work with Nix, you can add this to your configuration file in just a few lines.

Copy-paste prompts

Prompt 1
Show me how to add nix-emacs to my Emacs configuration to get Nix option autocomplete.
Prompt 2
Explain how to trigger helm-nixos-options and search for a specific NixOS setting.
Prompt 3
Help me set up company-mode integration from nix-emacs so I see Nix option docs as I type.
Prompt 4
Walk me through what happens when I hover over a Nix option using this package.

Frequently asked questions

What is nix-emacs?

An Emacs toolkit that adds searchable option lookup and autocomplete for Nix configuration files, so NixOS users get IDE-like help without leaving the editor.

What language is nix-emacs written in?

Mainly Emacs Lisp. The stack also includes Emacs Lisp, Helm, company-mode.

Is nix-emacs actively maintained?

Dormant — no commits in 2+ years (last push 2015-07-26).

How hard is nix-emacs to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is nix-emacs for?

Mainly developer.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.