simple-recorder
A single purpose application for naming file recording in OBS.
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 Release 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>
Use
Without passing a subcommand (start/stop) a GUI will be launched, otherwise a CLI will be launched.
GUI
Just enter the filename and click Start Recording.
Themes
Load the GUI with different themes:
simple-recorder --theme="Light Purple"
Available themes: Light Purple, Neutral Blue, Reds, Sandy Beach, Kayak, Light Blue 2, Dark Teal1
CLI
Usage: simple-recorder [OPTIONS] COMMAND
┏━ Subcommands ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ start Start recording ┃
┃ stop Stop recording ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
┏━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ --host <HOST> ┃
┃ --port <PORT> ┃
┃ --password <PASSWORD> ┃
┃ --theme <THEME> ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
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.