onyx_online/simple-recorder
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/simple-recorder.git synced 2025-06-27 09:50:23 +01:00
Code Issues Packages Projects Releases Wiki Activity
simple-recorder/README.md
onyx-and-iris 69595794e5 add badges
2025-06-25 14:40:04 +01:00

2.5 KiB
Raw Blame History

simple-recorder

pdm-managed Ruff

A single purpose application for naming a file recording in OBS.

Run it as a CLI or a GUI.

Requirements

  • Python 3.11 or greater

Installation

with uv

uv tool install simple-recorder

with pipx

pipx install simple-recorder

Use

Without passing a subcommand (start/stop) a GUI will be launched, otherwise a CLI will be launched.

GUI

simple-recorder

Just enter the filename and click Start Recording.

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.