dspk remote

Work with a serve server: info, files, sort on it, status, logs, stop

dspk remote [OPTIONS] --identity <IDENTITY> <ADDR> <COMMAND>

Arguments

• <ADDR>
  Server address (IP:port)

Options

• --identity <IDENTITY>: env DSPK_IDENTITY
  This client’s identity: the file dspk clients enroll wrote for it
• --server-name <SERVER_NAME>: default localhost
  Name the server’s certificate must carry (one of its –name, or localhost)

dspk remote info

Who the server is, who this client is to it, and what it is doing

dspk remote --identity <IDENTITY> <ADDR> info [OPTIONS]

dspk remote files

The files under the server’s data root (directories, recordings, sortings)

dspk remote --identity <IDENTITY> <ADDR> files [OPTIONS] [DIR]

Arguments

• [DIR]: default ""
  A directory under the data root (default: the root)

dspk remote sort

Sort a recording on the server (control permission)

dspk remote --identity <IDENTITY> <ADDR> sort [OPTIONS] <RECORDING>

Arguments

• <RECORDING>
  The recording, under the server’s data root

Options

• --sorter <SORTER>: default kilosort4
  kilosort4, emusort, mountainsort5, spykingcircus2, tridesclous2
• --output <OUTPUT>: default ""
  Where the sorting goes, under the data root (default: next to the recording, <name>.<sorter>.sorting.zarr)
• --probe <PROBE>: default ""
  A probe preset (default: the recording’s own geometry)
• --source <SOURCE>: default ""
  The source within the recording’s file (default: its default one)
• --start-sec <START_SEC>: default 0
  Start of the part to sort (s)
• --duration-sec <DURATION_SEC>: default 0
  Length of the part to sort (s; 0 = to the end)
• --param <PARAMS>
  A sorter parameter away from its default, as name=value (repeat; names as in dspk sort <sorter> --help, without “–”)
• --wait
  Follow the sort to its end

dspk remote status

The server’s state and its job’s progress

dspk remote --identity <IDENTITY> <ADDR> status [OPTIONS]

Options

• --follow
  Keep showing it until the job ends

dspk remote logs

The job’s last log lines

dspk remote --identity <IDENTITY> <ADDR> logs [OPTIONS]

Options

• -n, --lines <LINES>: default 50

dspk remote stop

Stop the running job (control permission)

dspk remote --identity <IDENTITY> <ADDR> stop [OPTIONS]

dspk remote fetch

Fetch a file, or a directory such as a .sorting.zarr, into a new local path

dspk remote --identity <IDENTITY> <ADDR> fetch [OPTIONS] <PATH> [DEST]

Arguments

• <PATH>
  Under the server’s data root
• [DEST]
  Where to put it (default: its name, here); never overwritten