ELEKTROID-CLI(1)

NAME
elektroid-cli - Sample and MIDI device manager (CLI)

SYNOPSIS
elektroid-cli [options] command

DESCRIPTION
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

•   Arturia MicroBrute

•   Arturia MicroFreak

•   Casio CZ-101

•   Elektron Analog Four MKI, MKII and Keys

•   Elektron Analog Heat MKI, MKII and +FX

•   Elektron Analog Rytm MKI and MKII

•   Elektron Digitakt I and II

•   Elektron Digitone I and II and Digitone Keys

•   Elektron Model:Cycles

•   Elektron Model:Samples

•   Elektron Syntakt

•   Eventide ModFactor, PitchFactor, TimeFactor, Space and H9

•   KORG padKONTROL

•   KORG Volca Sample and Volca Sample 2

•   Moog Little Phatty and Slim Phatty

•   Novation Summit and Peak

•   Samplers implementing MIDI SDS

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.

[ ld | list-devices ]
    List devices

info device_number
    Show device info

[ df | info-storage ] device_number
    Show size and use of the available storages

send file device_number
    Send MIDI data file to device

receive device_number file
    Receive MIDI data file from device

upgrade firmware device_number
    Upgrade the device

play file
    Play audio file

record file
    Record into file

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.

SEE ALSO
The GitHub page provides some examples: <https://dagargo.github.io/elektroid/>

AUTHOR
elektroid-cli was written by David García Goñi <dagargo@gmail.com>.

This manual page was written by Dennis Braun <snd@debian.org> for the Debian project (but may be used by others).