Command Line Interface

neptune

Neptune stores run data on disk in '.neptune' directories. In case a run is tracked in offline mode or the network becomes unavailable and Neptune switches to the offline mode, run data can be synchronized with the server with this command-line utility.

Usage

neptune [OPTIONS] COMMAND [ARGS]...

Options

--help

Shows CLI usage - options, commands and their arguments

neptune status

List synchronized and unsynchronized runs in the given directory. Trashed runs are not listed.

Options

--path <location>

A path to a directory containing a '.neptune' folder with the stored runs.

--help

Show command's usage and exits.

Examples

# List synchronized and unsynchronized runs in the current directory
neptune status
# List synchronized and unsynchronized runs in directory "foo/bar" without actually syncing
neptune status --path foo/bar

neptune sync

Synchronizes runs with unsent data with the server. You can list unsynchronized runs with neptune status.

Options

--path <location>

A path to a directory containing a '.neptune' folder

with the stored runs.

--run <run-name>

Run name ("workspace/project/short-id" or UUID

for offline runs) to synchronize.

-p, --project project-name

Project name ("workspace/project") where offline runs

should be sent.

--help

Show command's usage and exits.

Examples

# Synchronize all runs in the current directory
neptune sync
# Synchronize all runs in the given path
neptune sync --path foo/bar
# Synchronize only runs "NPT-42" and "NPT-43" in "workspace/project" in the current directory
neptune sync --run workspace/project/NPT-42 --run workspace/project/NPT-43
# Synchronise all runs in the current directory, sending offline runs to project "workspace/project"
neptune sync --project workspace/project
# Synchronize only the offline run with UUID offline/a1561719-b425-4000-a65a-b5efb044d6bb
# to project "workspace/project"
neptune sync --project workspace/project --run offline/a1561719-b425-4000-a65a-b5efb044d6bb

Runs created in an offline mode need a specified project where to be uploaded. You can either specify it through --project parameter or by setting NEPTUNE_PROJECT environment variable.