onyx_online/obsws-cli
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/obsws-cli.git synced 2025-11-03 23:21:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
obsws-cli/README.md
onyx-and-iris 88635ed152 rename item command group to scene-item 
update tests, rename test_item.py to test_sceneitem.py

update README

minor bump
2025-04-20 13:39:09 +01:00

3.5 KiB
Raw Blame History

obsws-cli

Hatch project Ruff

Table of Contents

Requirements

Installation

with uv
uv tool install .
with pipx
pipx install .

The CLI should now be discoverable as obsws-cli

Configuration

Flags

Pass --host, --port and --password as flags to the root command, for example:

obsws-cli --host=localhost --port=4455 --password=<websocket password> --help

Environment Variables

Store and load environment variables from:

  • A .env file in the cwd
  • user home directory / .config / obsws-cli / obsws.env
OBSWS_HOST=localhost
OBSWS_PORT=4455
OBSWS_PASSWORD=<websocket password>

Flags can be used to override environment variables.

Root Typer

  • version: Get the OBS Client and WebSocket versions.
obsws-cli version

Sub Typers

Scene

  • list: List all scenes.
obsws-cli scene list
  • current: Get the current program scene.
obsws-cli scene current
  • switch: Switch to a scene.
    • args: <scene_name>
obsws-cli scene switch LIVE

Scene Item

  • show: Show an item in a scene.
    • args: <scene_name> <item_name>
obsws-cli scene-item show START "Colour Source"
  • hide: Hide an item in a scene.
    • args: <scene_name> <item_name>
obsws-cli scene-item hide START "Colour Source"
  • list: List all items in a scene.
    • args: <scene_name>
obsws-cli scene-item list LIVE

Group

  • show: Show a group in a scene.
    • args: <scene_name> <group_name>
obsws-cli group show START "test_group"
  • hide: Hide a group in a scene.
    • args: <scene_name> <group_name>
obsws-cli group hide START "test_group"
  • list: List groups in a scene.
    • args: <scene_name>
obsws-cli group list START

Input

  • list: List all inputs.
obsws-cli input list
  • mute: Mute an input.
    • args: <input_name>
obsws-cli input mute "Mic/Aux"
  • unmute: Unmute an input.
    • args: <input_name>
obsws-cli input unmute "Mic/Aux"
  • toggle: Toggle an input.
obsws-cli input toggle "Mic/Aux"

Record

  • start: Start recording.
obsws-cli record start
  • stop: Stop recording.
obsws-cli record stop
  • status: Get recording status.
obsws-cli record status
  • toggle: Toggle recording.
obsws-cli record toggle
  • resume: Resume recording.
obsws-cli record resume
  • pause: Pause recording.
obsws-cli record pause

Stream

  • start: Start streaming.
obsws-cli stream start
  • stop: Stop streaming.
obsws-cli stream stop
  • status: Get streaming status.
obsws-cli stream status
  • toggle: Toggle streaming.
obsws-cli stream toggle

License

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