ELEKTROID-CLI(1)

📦
version 3.4 · 6 versions
, in arch rolling

🎛️ ELEKTROID-CLI — the General Commands Manual, but make it cute

okay bestie, so this is elektroid-cli, live from the General Commands Manual section of the library 💅 it's the command-line version of Elektroid, and she's literally the backstage pass to all your sample and MIDI device drama. no GUI, just vibes and flags.

✨ NAME ✨

elektroid-cli — Sample and MIDI device manager (CLI) 🎀

🦋 SYNOPSIS 🦋

elektroid-cli [options] command

that's it. that's the whole entrance exam. [options] then a command. iconic behavior.

💖 DESCRIPTION 💖

so elektroid-cli is part of Elektroid, a sample and MIDI device manager. if you want the fancy windowed version, go see man elektroid for the GUI app — she's the main character, this one's the cool older sister who lives in your terminal 🫶

with Elektroid you can easily upload and download audio files and manage all sorts of different types of data on all sorts of different MIDI devices — think presets, projects, tunings, the whole aesthetic ✨ it can also send and receive SysEx MIDI files, because of course it can. versatile queen.

👑 SUPPORTED DEVICES 👑

the roster. the lineup. the guest list 🔥

  • 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

no cap, that's a stacked list 💀

🌈 DEVICE COMMANDS 🌈

these ones operate over the device itself, like, directly. for the commands that operate over the different types of data a device provides, scroll on down to the filesystem commands section, bestie 👇

  • [ 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 these two forms. pay attention, this part matters 🧚

  • 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 🙈 like, please. just use the colon one.

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. important!! don't come crying to me when it doesn't work because you forgot the device id 💀

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
⚠️ heads up bestie, rmdir / rm on a directory is recursive. she takes the whole folder with her. no undo. be so serious about this one 😭
  • [ 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 ] — Download file into the destination directory or the current directory if not provided.
[ dl | download | rdownload | rdl | backup ] device_number:path_to_file_or_directory [ destination ]
  • mv device_number:path_to_file_or_directory — Move file. If the destination path does not exist, it will be created.
mv device_number:path_to_file_or_directory device_number:path_to_file_or_directory
  • 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. yes, more than once. stack 'em. she loves that 📚

🍓 EXAMPLES 🍓

this is the part where it all clicks, i promise 🫶

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. look at that colon-colon action, she ate 💅

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, and honestly? go look, iykyk:

<https://dagargo.github.io/elektroid/>

💜 AUTHOR 💜

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

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

okay that's the whole page, bestie, you're officially educated 💖 this was the elektroid-cli(1) manual, dated Jan 2023 — go forth and manage those samples, periodt 🎀✨🦋

📦 where this page comes from