Skip to content

Neptune CLI overview#

Neptune Command Line Interface (Neptune CLI) is a command-line utility that helps you synchronize metadata with the Neptune servers manually.

You may need to manually sync data if the tracked metadata could not be uploaded to Neptune, for example:

  • Due to connectivity issues
  • If you logged data in offline mode
  • (Old pricing model based on logging hours) If the logging hours for your workspace were exceeded

Related

Connection modes reference

General usage#

Neptune stores data on-disk in a .neptune folder of the current working directory.

You can execute neptune commands:

  • In the directory where the .neptune folder is located (typically where you run your scripts).
  • In a different location, by providing a path to the .neptune parent folder.

Command syntax: neptune COMMAND [OPTIONS...] [ARGS...]

This means that the structure is always neptune <command>, optionally followed by one or more options (flags) and arguments. For details, see the page of each specific command.

The --help flag is available for all commands:

Option Description
--help Shows CLI usage: options, commands, and their arguments.

Commands#

Note

Neptune CLI commands are not Python commands. You run them on the command line in a console or terminal program, such as Terminal on macOS or Command Prompt on Windows.