Neptune CLI
With the Neptune Command Line Interface (CLI), you can manually send locally stored metadata to the Neptune app.
neptune sync
Synchronizes a locally stored offline run with the server. The run is sent to the project that was specified when the run was created.
In case of connectivity issues, the process retries indefinitely by default. You can change the waiting time by setting the --timeout flag.
Usage
neptune sync [OPTIONS...] PATH_TO_RUN_FILE
where PATH_TO_RUN_FILE points to an offline run's .sqlite3 file. By default, the file is created in the current working directory's .neptune folder.
Options
| Option | Description |
|---|---|
--api-token | Account's Neptune API token. Must have access to the target project. |
--timeout | Timeout for the sync operation, in seconds. The default is no timeout. |
--help | Get information about the command. |
Examples
Synchronize an offline run from the default Neptune data directory:
neptune sync .neptune/team-alpha_project-x_likable-barracuda_174193.sqlite3
More options
Set a timeout for the syncing operation:
neptune sync --timeout=600.0 .neptune/team-alpha_project-x_likable-barracuda_174193.sqlite3
Synchronize forked runs
To successfully sync offline experiments consisting of multiple related runs, you must first synchronize the parent run and then one or more children, in the correct order.
The example shows a valid command order given the following forking tree:
gerbil-A1 # first run
|---- gerbil-B1
|---- gerbil-B2 # forked off gerbil-A1
|---- gerbil-C1 # forked off gerbil-B2
neptune sync .neptune/team-alpha_project-x_gerbil-A1_184289.sqlite3
neptune sync .neptune/team-alpha_project-x_gerbil-B2_474593.sqlite3
neptune sync .neptune/team-alpha_project-x_gerbil-C1_176998.sqlite3