Installing

Neuron can be installed on Windows, Linux or macOS.

Prerequisites

Nix

First, install the Nix package manager1:

curl -L https://nixos.org/nix/install | sh

OS-specific notes

Enable cache

Unless you like compiling for two+ hours, enable the Nix cache for neuron.

# If you do not already have cachix, install it:
nix-env -iA cachix -f https://cachix.org/api/v1/install
# Use the cache to fetch binaries instead of compiling most packages.
cachix use srid

Install neuron

To install the latest development version of neuron, run:

nix-env -if https://github.com/srid/neuron/archive/master.tar.gz

Note that this command can also upgrade your existing install of neuron.

For alternative mechanisms, see Declarative Install.

Test your install

Make sure that you can execute the neuron executable. You should expect the following:

$ neuron --help
Usage: neuron [--version] [-d|--zettelkasten-dir NOTESDIR] COMMAND
  Neuron, a Zettelkasten CLI <https://neuron.zettel.page/>

Available options:
  --version                Show version
  -d,--zettelkasten-dir NOTESDIR
                           Your zettelkasten directory containing the zettel
                           files (default: /home/srid/zettelkasten)
  -h,--help                Show this help text

Available commands:
  new                      Create a new zettel
  open                     Open the locally generated Zettelkasten website
  search                   Search zettels and print the matching filepath
  query                    Run a query against the zettelkasten
  rib                      Generate static site via rib

What’s next?

Proceed to the Tutorial.

  1. Nix is a general package manager that you can use to manage other software and services as well. See here. If you do not wish to install Nix, try the Docker workflow. If you are on Linux, you may alternatively try the static bundle neuron-linux-bundle from the nightly release.

    ↩︎
Created on: