User Guides

Explainers and tutorials on how to use or get started using the various software packages that constitute the client.

Building the software, or installing it using a script, yields four executables. Two of these executables are user interfaces. The executables are:

  • neptune-core is the daemon that runs the protocol.
  • triton-vm-prover is a binary invoked by neptune-core for out-of-process proving tasks.
  • neptune-dashboard is a terminal user interface that requires a running instance of neptune-core.
  • neptune-cli is a command-line interface that might require a running instance of neptune-core depending on the command.

Except for the installation instructions, the user guides in this section assume these executables are installed.