elektroid-cli1

Usage

Overview

elektroid-cli is part of Elektroid, a sample and MIDI device manager. See man elektroid for the GUI application.

With Elektroid you can easily upload and download audio files and manage different types of data on different MIDI devices, such as presets, projects or tunings. It can also be used to send and receive SysEx MIDI files.

Supported devices

Device commands

Device commands operate over the device itself. For the commands that operate over the different types of data a device provides see the filesystem commands section.

Filesystem commands

Different filesystem operations are implemented on different connectors so a command has one of the following forms:

•

connector, colon (':'), filesystem name, colon (':'), and the operation itself. This is the preferred way.

•

connector, hyphen ('-'), filesystem name, hyphen ('-'), and the operation itself. This should be avoided.

Provided paths must always be prepended with the device id and a colon (':'), e.g. 0:/samples. Paths pointing to a data, sound or project file use the index of a file instead of its name.

These are the available operations.

[ ls | list ] device_number:path_to_directory

List directory

mkdir device_number:path_to_directory

Create directory and its parent directories as needed

[ rmdir | rm ] device_number:path_to_directory

Delete directory recursively

[ ul | upload ] file device_number:path_to_file_or_directory

Upload file. If the path does not exist it will be created.

[ dl | download | rdownload | rdl | backup ] device_number:path_to_file_or_directory [ destination ]

Download file into the destination directory or the current directory if not provided.

mv device_number:path_to_file_or_directory device_number:path_to_file_or_directory

Move file. If the destination path does not exist, it will be created.

rm device_number:path_to_file

Delete file

cl device_number:path_to_file

Clear file

cp device_number:path_to_file device_number:path_to_file

Copy file

sw device_number:path_to_file device_number:path_to_file

Swap files

Options

-v give verbose output. Use it more than once for more verbosity.

Examples

elektroid-cli ld

lists the available devices.

elektroid-cli info 0

shows information about the device, including the connector and the available filesystems.

elektroid-cli elektron:sample:ul square.wav 0:/waveforms

uploads a sample to an Elektron device.

elektroid-cli sds:mono-16b:dl 0:/1

downloads a mono 16 bits sample from an SDS sampler.

elektroid-cli summit:single:ls 0:/A

lists Novation Summit single patches in bank A.