meld-cli/README.md

meld-cli

A command line interface for Meld Studio WebChannel API

---

Requirements

• Meld Studio
• Tested with node v22.17.0 (lts).

Installation

npm i -g @onyx-and-iris/meld-cli

Configuration

Flags

• --host/-H: Host address for the Meld server
• --port/-P: Port number for the Meld server

Environment Variables

Load the following values from your environment:

MELD_CLI_HOST=localhost
MELD_CLI_PORT=13376

Commands

Scene

• list: List all scenes
  • flags:
    • --id: Display scene IDs

meld-cli scene list

meld-cli scene list --id

• switch: Switch to a scene by name
  • args: sceneName

meld-cli scene switch "My Scene"

• current: Show the current scene
  • flags:
    • --id: Display scene ID

meld-cli scene current

meld-cli scene current --id

Audio

• list: List all audio devices
  • flags:
    • --id: Display audio IDs

meld-cli audio list

meld-cli audio list --id

• mute: Mute the audio
  • args: audioName

meld-cli audio mute "Mic"

• unmute: Unmute the audio
  • args: audioName

meld-cli audio unmute "Mic"

• toggle: Toggle audio mute state
  • args: audioName

meld-cli audio toggle "Mic"

• status: Show current audio status
  • args: audioName

meld-cli audio status "Mic"

• gain: Adjust the audio gain
  • args: audioName gainValue

meld-cli audio gain "System" -12.8

Stream

• start: Start streaming

meld-cli stream start

• stop: Stop streaming

meld-cli stream stop

• toggle: Toggle streaming state

meld-cli stream toggle

• status: Show the current streaming status

meld-cli stream status

Record

• start: Start recording

meld-cli record start

• stop: Stop recording

meld-cli record stop

• toggle: Toggle recording state

meld-cli record toggle

• status: Show the current recording status

meld-cli record status

Clip

• save: Save a clip

meld-cli clip save

Screenshot

• take: Take a screenshot

meld-cli screenshot take

Virtual Camera

• toggle: Toggle the virtual camera on or off

meld-cli virtualcam toggle

Special Thanks

• Meld team for providing the WebChannel API on which this CLI depends.

License

meld-cli is distributed under the terms of the MIT license.