simple-recorder/README.md

simple-recorder

A simple OBS recorder app. Run it as a CLI or a GUI.

---

Requirements

• Python 3.11 or greater
• OBS Studio 28+

Installation

with uv

uv tool install simple-recorder

with pipx

pipx install simple-recorder

with pyz

An executable pyz has been included in Releases which you can run in Windows. Follow the steps in this Setting up Windows for Zipapps guide.

Configuration

Pass --host, --port and --password as flags on the root command:

simple-recorder --host=localhost --port=4455 --password=<websocket password> --help

Or load them from your environment:

OBS_HOST=localhost
OBS_PORT=4455
OBS_PASSWORD=<websocket password>
OBS_THEME=Reds

Use

GUI

To launch the GUI run the root command without any subcommands:

simple-recorder

Just enter the filename and click Start Recording.

Themes

However, passing flags is fine, for example to set the theme:

simple-recorder --theme="Light Purple"

CLI

Usage: simple-recorder [OPTIONS] COMMAND

┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ start  Start recording                                                              ┃
┃ stop   Stop recording                                                               ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ --host <HOST>          OBS WebSocket host                                           ┃
┃ --port <PORT>          OBS WebSocket port                                           ┃
┃ --password <PASSWORD>  OBS WebSocket password                                       ┃
┃ --theme <THEME>        GUI theme (Light Purple, Neutral Blue, Reds, Sandy Beach,    ┃
┃                        Kayak, Light Blue 2)                                         ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

To launch the CLI pass any subcommand (start/stop etc...), for example:

simple-recorder start "File Name"

simple-recorder stop

• If no filename is passed to start then you will be prompted for one.
  • A default_name will be used if none is supplied to the prompt.