How to use obs-cli

[JyotstnaDeviChintala]

obs-studio 28.0.1.0 is installed in C:\Program Files

i have downloaded obs-cli 0.5.0 WIndows x86_64

do i need to copy it to some folder in obs-studio to start using it form cmd.exe ?

i think obs-studio 28.0.1.0 has obs-websocket built in.. so no new plugin is needed

when i run the command from cmd.exe i get the folllowing error

obs-cli recording start
error: dial tcp [::1]:4444: connectex: No connection could be made because the target machine actively refused it.

Pls suggest on how to use

[onyx-and-iris]

Hi. OBS 28 has websocket v5 built in but obs-cli 0.5.0 supports websocket v4. If you check #64 yusefnapora has kindly started implementing v5 support. So you can use https://github.com/yusefnapora/obs-cli/tree/protocol-v5 until obs-cli is officially updated.

Otherwise you'll have to install the obs-websocket compat plugin for OBS 28.

Once you have compatible library/plugin you can run any command and pass connection flags.

Example

obs-cli recording start --host "localhost" --port 4455 --password "strongpassword"

[JyotstnaDeviChintala]

Hi, i followed all the below steps .. still the same error

Using the installer (recommended) : download obs-websocket-4.9.1-compat-Qt6-Windows-Installer.exe, launch it and follow the instructions.
Using the obs-websocket-4.9.1-compat-Qt6-Windows.zip archive : copy the contents of the archive to the root of your OBS Studio installation folder (C:\Program Files\obs-studio).

[onyx-and-iris]

well have you configured websocket settings in OBS? I haven't tried using the obs-websocket-4.9.1-compat plugin btw, I used the v5 compatible fork I linked above.

For me it was as simple as clone fork, install it. Configure websocket settings in OBS and then run the command as above.

[JyotstnaDeviChintala]

ok i have to run the obs64.exe to get this obs-cli connected and run.

is there a way to hide the obs-studio UI window while running and still get obs-cli connected?