Installing
Neuron can be installed on Windows, Linux or macOS.
Prerequisites
Nix
Neuron can be installed via the Nix1 package manager. Install Nix as follows:
curl -L https://nixos.org/nix/install | sh
Enable cache
Enable the Nix cache for neuron.
nix-env -iA cachix -f https://cachix.org/api/v1/install
cachix use srid
If you skip this step, your machine may compile several software for hours.
Install neuron
To install the latest development version2 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:
Usage: neuron [--version] [-d PATH] [-o PATH] COMMAND
Neuron, future-proof Zettelkasten app <https://neuron.zettel.page/>
Available options:
--version Show version
-d PATH Run as if neuron was started in PATH instead of the
current working directory
-o PATH Custom path to generate static site in
-h,--help Show this help text
Available commands:
gen Generate and serve the static site
new Create a new zettel
open Open the local static site
search Search zettels and print their path
query Query the zettelkasten in JSON
What’s next?
Proceed to the Tutorial.