Commands

Command Line Interface

CLI interface to the Volca Sample toolkit.

Operation via CLI requires a set of common options. Each subcommand may have extra options, like this:

volcasample <common options> SUBCOMMAND <subcommand options>
usage: volcasample [-h] [--project PROJECT]
                   [--start {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99}]
                   [--span {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99}]
                   [--version] [-v] [--log LOG_PATH]
                   {project,audition,patch} ...

Positional Arguments

command

Possible choices: project, audition, patch

Commands:

Named Arguments

--project

path to project directory [/home/boss/volcasamples]

--start

Possible choices: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99

Select the project index to begin at.

--span

Possible choices: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99

Select the number of slots to operate on.

--version

Print the current version number

-v, --verbose

Increase the verbosity of output

--log

Set a file path for log output

Sub-commands:

project

Operates on your project tree.

volcasample project [-h] [--new] [--check] [--vote VOTE]
Named Arguments
--new

Create a new project.

--check

Check the audio file(s) can be loaded to the Volca. This command converts stereo files to mono if necessary.

--vote

Change your vote on an audio file. Use +1, -1 to adjust the vote up or down. Otherwise supply a digit as the vote value.

audition

Evaluate your project audio.

volcasample audition [-h] [--silent]
Named Arguments
--silent

Don’t play project audio file(s).

patch

Create a patch for your Volca.

volcasample patch [-h] [--silent] [--vote VOTE] [instructions]
Positional Arguments
instructions

Define patch instructions.

Named Arguments
--silent

Don’t play patch file.

--vote

Set a threshold for votes. Samples with a vote total below this value will not be included in the patch.