Command Reference

Reference for nbcli commands. For more detailed info, checkout the nbcli commands database. If you are just getting started, please go the nbcli Github repo for installation instructions and demo code examples.

o-sigv is a segment of the nbcli research made to allow the modules to be live coded with Orca and other live coding languages that can customize outgoing OSC (Open Sound Control) messages. Follow instructions on the o-sigv repo for using Orca (desktop or Electron versions) with the modules.

Videos of experiments in live coding with nbcli and modular synthesizers, visual experiments with and without sound, and performances with the Endemics Collective can be seen here.

Core

sigv [options]
Initialize and start the meta-instrument session
--config
Open configuration file
--b
Change terminal directory to nbcli.
--m string
Load command man page

Examples

sigv --config # Open default configuration
new [module] 0 0 [module]
Loading new commands (modules)
module string
Name of module (command)

Examples

new geo 0 0 geo # Loads new geo module/command
s [options]
sigv OSC operator
[module] [param] string
Bash operation to call sigv. 
                                    function s() { $HOME/sigv/nbcli/max/s "$*" }

Examples

s focus geo # Sets focus of nature command to geo module.
o [options]
Orca osc send utility
[Orca operation] string
Bash operation to call sigv.


Code:
echo "$1" | nc -vuw 0 192.168.x.xx 49160 &

Examples

o "write:H;10;22" # Writes the letter H at position 10,22 in Orca's grid.

Sonic

aio [options]
sigv audio interface
options string
activate | sigx | sigy | sig | phase | pwr

nbcli.DB.aio

Examples

aio pwr 1 # Powers on the audio interface
lttp [options]
Listen to the Pictures (LTTP://) standalone element
options string
sub | ch | metro | activate | slider | close | port | pos | drunk

nbcli.DB.lttp

Examples

lttp activate 1 # Powers on the lttp module.
lttp pos 352 # Move lttp image scan slider to position 352 (value in x position of pixel dimension being scanned).
nature [options]
Audio/biquad sensor
options string
bi | mult | peak | mode | sense

nbcli.DB.nature

options:mode morph turn group tex bloom line

Examples

nature mode bloom 1 # Powers on the bloom response (same as running 
fx . bloom_amt 3.5
).
nature sense hi 1 # Turns on hi range sensitivity.
midi [options] or note [options]
MIDI interface element.
options string
vol | vst1 | vst2 | vst3 | vst4 | inport | outport | note

nbcli.DB.midi
Note param mostly used for sending a single note message.

Examples

midi vst1 plug london.vst # Opens Korg London synth into first vst buffer.
wave [options]
Multichannel voice-allocated wavetable synth.
options string
activate | metro | buffer | freq | start | end | env | vol

nbcli.DB.wave

Examples

wave buffer test.wav # Opens test.wav file into wave buffer.
wave activate 1# Activates wave module for use.
grain [options]
Gen-based granular synthesizer.
options string
activate | metro | buffer | freq | start | end | env | vol

nbcli.DB.grain

Examples

grain sample sine.wav # Opens sine.wav file into grain buffer.
grain density 100# Changes grain density to 100.
spk [value] and/or [options]
16 channel audio buffer/player element.
value number
1 ... 16
options string
play

nbcli.DB.spk

Examples

spk 2 read $snd-clips/drumstep.wav # Opens drumstep.wav file into spk 2 buffer.
spk 2 open# Opens a view of the waveform in spk 2 buffer.
synth [options]
Internal unit generator synth (beta).
options string
tri | cycle | saw | rect | amp

nbcli.DB.synth

Examples

synth read $snd-clips/drumstep.wav # Opens drumstep.wav file into spk 2 buffer.
spk 2 open# Opens a view of the waveform in spk 2 buffer.

Spatial

fpic [options]
main texture buffer name (loaded as tex0)
options string
read | 1 | 2 | 3

Examples

fpic read $arboreal/flocons-bleus.jpg # Loads image into texture tex0
fpic 2 read $hdri/smog6.exr # Loads image into texture tex2
morph "[operation]" [repeat value] [repeat duration]
Morphing command for grain, geo and proc (norm)
operation string
statement of the operation to execute

repeat value number
amount of iterations of specified operation

repeat duration string
duration of each repeated value

Examples

morph "geo ^" 250 1 # Morphs geo modules shape 3 times (locked in value)randomly between geo gs1 shape and geo gs2 shape, 250 shape points over 1 second.
morph "grain position" 2500 1 # Morphs the grain synth playhead 3 times between positions, at a resolution of 2500 interpolated points.
morph0 "[operation]" [repeat value] [repeat duration]
Morphing command for grain, geo and proc (snorm)
operation string
statement of the operation to execute

repeat value number
amount of iterations of specified operation

repeat duration string
duration of each repeated value

Examples

morph0 "geo ^" 250 1 # Morphs geo modules shape 3 times (locked in value)randomly between geo gs1 shape and geo gs2 shape, 250 shape points over 1 second.
morph0 "grain pitch" 2500 1 # Morphs the grain synth pitch values 3 times between pitch transforms, at a resolution of 2500 interpolated points.
morpha "[operation]" [repeat value] [repeat duration] [interpolation cycles]
Morphing command for grain, geo and proc (snorm)
operation string
statement of the operation to execute

repeat value number
amount of iterations of specified operation

repeat duration string
duration of each repeated value

interpolation range string
Number of interpolation cycles to tranistion between.
shady [options]
Loads an OpenGL shader in Max Jitter format (.jxs)
options string
vert | x | y | z | frag | rgb | mesh | run | shader

Examples

shady file myshader.jxs # Loads loads shader file and renders to wrld
frag [options] [interpolation cycles]
Create fragment shader. Shady shortcut to frag parameter.
options string
GLSL code to execute
lz [options]
Lorenz strange attractor element.
options string
sample | activate | mesh | anim | material | ^ | a | b | c | dt | val | data | aio | gs | reset | iso | handle | particles | specs | .

nbcli.DB.lz

Examples

lz activate 1 # Activates Lorenz attractor for use.
lz sample 1# Starts Lorenz simulation at default initial set conditions (same as lz ^ 10. 28. 2.667 0.001).
movie [options]
see wrld
b1...b7 [options]
3D biome element.
options string
anim | triple | reset | iso | tex | handle | .

nbcli.DB.b1

Examples

b1 read $models/landscape.dae # Loads a 3D model file (tested formats include .dae and .fbx).
fx [options]
Post-processing effects in wrld (4 layers)
options (atmospheric) string
color | altitude | density | quality | file | drawto | . | .. | ...

nbcli.DB.fx

Examples

fx density 10. # Add atmospheric density to the wrld.
rossler [options]
Alpha tester for Rossler strange attractor.
options string
sample | activate | mesh | anim | material | ^ | a | b | c | d

nbcli.DB.rossler

Examples

rossler activate 1 # Activates Rossler attractor for use.
rossler sample 1# Starts Rossler simulation at default initial set conditions.
sketch [options]
OpenGL drawing module.
options string
anim | handle

nbcli.DB.sketch
typo [options]
A typography module
options string
text | mode | scale | fontsize | triple | anim | reset | iso | material | mesh

Examples

typo text hello # Prints "hello" on screen.
typo mode 2d; typo fontsize 72# Changes mode to 2D, then changes the font size to 72px.
typo mode 3d# Changes mode to 3D.
typo scale 2 2 2# Scales text to double its size in 3D wrld.
bfg [options]
Procedural noise generator module
options string
scale | weight | basis | origin | offset

nbcli.DB.bfg

Examples

geo material diffuse_texture bfg # Adds bfg to geo object texture.
geo material heightmap_texture bfg # Adds bfg as heightmap texture to deform geo object shape.
bfg weight 0.36 # Changes the bfg weight parameter.
sky [options]
3D skybox module.
options string
cubemap | anim

nbcli.DB.sky
vert [options] [interpolation cycles]
Create frvertexagment shader. Shady shortcut to vert parameter.
options string
GLSL code to execute
biomes [options]
wrld layer for loading biome models
options string
layer | anim

nbcli.DB.biomes

Examples

b1 drawto biomes # Adds b1 module to biomes layer.
biomes anim turn 0 1 0# Animate biomes layer rotating on y-axis. All visual modules on this layer will be animated.
geo [options]
Parametric geometry module
options string
reset | anim | triple | iso | material | gs1 | gs2 | ^ | handle | op | export | mesh | aio | vo | slide

nbcli.DB.geo

Examples

geo mesh draw_mode line_loop # Changes shape drawing to looped lines.
geo aio 1; geo aio ^ .1 # Turns on audio responsive mode, then activates a precision of .1 for sensitivity. Change precision to .4 increases sensitivity, but scales down geometry in space by 4.
geo anim scaleto 4 4 4 20 # Scales up the geometry by 4 on the x, y and z axes over 20 seconds time.
plato [options]
Platonic solid geometry module
options string
reset | anim | triple | iso | material | gs1 | gs2 | ^ | handle | op | export | mesh | aio | slide

nbcli.DB.plato

Examples

plato mesh draw_mode triangles # Changes shape drawing to triangles.
proc [options]
Procedural geometry module
options string
gs | clocker | scale | period | time | bfg | slide | material | mesh | anim | aio | mult

nbcli.DB.proc

Examples

new proc 0 0 proc; sleep 0.5; proc period 0.4; sleep 4; proc period 0. # Loads proc module, pauses for a half second, changes the periodicity of the shape transformation to 0.4, pauses for 4 seconds, then finally changes the periodicity to 0.
model [options]
3D model module
options string
handle | iso | material | mesh | anim | . | tex

nbcli.DB.model
nurbs [options]
NURBS surface module
options string
anim | triple | reset | iso | handle | surf

nbcli.DB.nurbs
som [options]
Module for self-organizing machine learning
options string
activate | q | gen | texture

nbcli.DB.som

options string
size (int) | neighbourhood (int) | learning (float) | plasticity (float)

Examples

som 32 14 0.05 0. # Sets parameter values for a self-organizing map.
camera [options]
Camera control command in wrld
options string
anim | c | t

nbcli.DB.camera

Examples

camera position 0 0 4 # Default position of camera on load of wrld.
monde [options]
Main wrld layer.
options string
anim

nbcli.DB.monde

Examples

monde anim turn 0 0.5 0 # Rotation of the wrld on y-axis.
specs [options]
Specifications text module.
options string
pk | bf | mk | enable

nbcli.DB.specs
wrld [options]
3D world context module
options string
visible | enable | size | dim | windowposition

nbcli.DB.wrld

Examples

new wrld 0 0 wrld; wrld size 400 400; wrld dim 400 400 # Loads wrld module with a 400 x 400 window view.
graph [options]
Graph plot module
options string
~ | val

nbcli.DB.graph
particles [options]
Basic particle system module
options string
dim | reset | mesh | material | shape

nbcli.DB.particles
eca [options]
1D elementary cellular automaton
options string
activate | clear | metro | rule | dim | texture

nbcli.DB.eca
terra [options]
Video-based procedural terrain module
options string
reset | coord | op | material | mesh | activate | qt | anim | aio | gs

nbcli.DB.terra

Kinetic

cv [options]
I/O control voltages via aio module
options string
tap | bpm | rate | pitch | osci | zero | pwr

nbcli.DB.cv
lfo [options]
Low frequency oscillator (LFO) module
options string
cycle | tri | saw | rect

nbcli.DB.lfo

Examples

lfo cycle 0.1 0.03 # Sets the values for increment/decrement, and generates list of values for modulation.

Pattern

rand [value]
Generate random number (integer)
value number
Maximum number range.

Examples

rand 200 # Generates a number that's between 0 and 200
randx [value a] [value b]
Generate random number generator (integer range a b)
value a number
Minimum number range.

value b number
Maximum number range.

Examples

randx 10 25 # Generates a number that's between 10 and 25
automata "[operation]" [duration]
Infinite pattern repeater
operation string
Operation to be repeated

duration number
Time of each repetition.

nbcli.DB.automata

Examples

automata "rand 50" 2 # Generates a number that's between 0 and 50 every 2 seconds
tilde [options]
Tilde receiver connector module (accessed via tilde or ~)
options string
set | src | link | tail

nbcli.DB.tilde

options:set string [nbcli operation]

Examples

tilde set geo ^ # Attaches the transform of the geo module to the tilde connector.
tilde src lfoc # Attaches the lfo cycle stream as a source of the tilde connector.
markov [options]
Markov machine learning module
operation string
activate | build | dump | reset | order | target

nbcli.DB.markov
gen [start value] [iteration value] [end value] [duration] [operation]
Main number generator based on Bash seq command
start value number (int or float)
Starting sequence number.

iteration value number (int or float)
Iteration amount.

end value number (int or float)
Ending sequence number.

duration number (int or float)
Length of every iteration of sequence.

operation string
Operation to sequence.

nbcli.DB.gen

Examples

gen 0. 0.1 1 0.5 "hello" # Generates a sequence of strings of "hello" once every half second, up to to 10 (10 points in 0.0 to 1.0 range).
rnr [value]
Random float number list generator (0 to 1)
value number (float)
Number of random float results to be printed

nbcli.DB.rnr

Examples

rnr 1 # Generates a random float value between 0. and 1.
rsr [value]
Random float number list generator (-1 to 1)
value number (float)
Number of random float results to be printed

nbcli.DB.rsr

Examples

rsr 1 # Generates a random float value between -1. and 1.
count [value]
Audible counter
value number (int)
Number to count to.

nbcli.DB.count

Examples

count 12 # Counts to 12 out loud (macOS only).
sfor [limit value] "[operation]" [duration]
C-style loop
limit value number (int)
Loop maximum

operation number (int)
Loop maximum

nbcli.DB.sfor

Examples

sfor 5 "rsr 1" 1 # Generates an unsigned (-1. 1.) floating number, every second until the loop prints 5 of them.

Time

timer [value]
Creates a timer that starts at zero (integer)
value number
Timer in seconds

Examples

timer 7 # Seven second timer.