Quickstart

For the agent-driven web editor, start with Studio workflow. This quickstart covers the local path, with a coding agent or by hand. Both paths edit projects built on the same SDK, DSP and UI contracts.

In the Help Center: Beta and early access for what is available to whom.

Availability. The maruaudio package is published on npm, but the local workbench and plug-in builds also need a toolchain that is provided to developers in the selected-developer beta. Without it, the workbench and plug-in builds are unavailable; maru doctor reports what this machine can do. Studio and the hosted connector work without it.

If you use a coding agent, connect it first and ask:

Create a new Maru effect project called my-delay and open the dev workbench.

To do it yourself, you need Node.js and a terminal. Install the CLI, create a project and open the workbench:

npm i -g maruaudio
maru init my-delay
cd my-delay
npm install
maru dev --open

The workbench opens with the module already connected to the appropriate audio or MIDI inputs. The default starter is a Processor effect: its sound processing is in src/dsp/processor.ts, its parameter schema in src/contract.ts and its face in src/ui/. The workbench rebuilds affected sources as you edit. Create a project describes the starters, and Project structure the files.

Run maru doctor at any point to see what this machine can do and what is missing.

Start from a prompt

Install the Maru agent skill with npx maruaudio skill install, then give your agent a concrete musical goal and a short interface direction:

Use the maru-agent skill. Read https://maru.audio/llms.txt.

Turn this starter into a warm stereo delay. Add time, feedback, tone, width,
and mix controls. Build a responsive React interface with a delay-tap display.
Run maru module check before stopping.

The agent can use the included nodes and UI components, or add ordinary web libraries for animation, WebGL, and 3D. You stay in the loop by listening and directing the result.

Check the module

maru module check

The check validates the module contract, face and build in order, and runs the starter's qualification render. To render your own audio through it, see rendering a Processor offline. In the workbench, also check input, output, controls, presets and state recall. Check, build and export covers the full set of module commands.

Native plugins

maru plugin build --format vst3

Native builds need a compiler toolchain that the maruaudio npm package does not include yet, so in this release the command stops with exit code 4 and says what is missing. Available formats vary by module and platform; the build only presents targets the project supports. Native plugins explains building, verifying and installing, and Testing your VST loading the result in a host.

Next, read Working with coding agents, How it works, or the CLI overview. If you have built plugins with another framework, start with Constraints for plugin developers.