10.1. Neo4j Admin

This section describes the Neo4j Admin tool.

Neo4j Admin is the primary tool for managing your Neo4j instance. It is a command-line tool that is installed as part of the product and can be executed with a number of commands. Some of the commands are described in more detail in separate sections.

10.1.1. Environment variables

Neo4j Admin can utilize the following environment variables:


Set to anything to enable debug output.


Neo4j home directory.


Path to directory which contains neo4j.conf.


Set JVM maximum heap size during command execution. Takes a number and a unit, for example 512m.

10.1.2. Exit codes

If neo4j-admin finishes as expected it will return an exit code of 0. A non-zero exit code means something undesired happened during command execution. The non-zero exit code can contain further information about the error, such as the backup command’s error codes.

10.1.3. Syntax and commands

Neo4j Admin is located in the bin directory and is invoked as:

neo4j-admin <command>

  • check-consistency Check the consistency of a database. For details, see the Consistency Checker.
  • help This help text, or help for the command specified in <command>.
  • import Import from a collection of CSV files or a pre-3.0 database. For details, see the import section.
  • store-info Prints information about a Neo4j database store.
  • set-default-admin Sets the default admin user when no roles are present.
  • set-initial-password Sets the initial password of the initial admin user ('neo4j').
Offline backup; For details see the section on dump and load commands
  • dump Dump a database into a single-file archive.
  • load Load a database from an archive created with the dump command.
Online backup; for details see the backup chapter
  • backup Perform an online backup from a running Neo4j enterprise server.
  • restore Restore a backed up database.

Use neo4j-admin help <command> for more details.