Contact Us
Built by ML engineers for ML engineers with ❤️
Contact

Neptune CLI overview

Overview of the neptune.ai Command Line Interface tool.

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

Connection modes reference

General usage

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

You can executeneptunecommands:

  • 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:neptuneCOMMAND[OPTIONS...][ARGS...]

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

The--helpflag is available for all commands:

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

Commands

  • neptune clear - clear lingering junk metadata from the .neptune folder
  • neptune status - check the synchronization status
  • neptune sync - synchronize data manually

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.

This page is originally sourced from the legacy docs.