obs-scheduler

!NPM Version
!Static Badge

A CLI for scheduling actions in OBS.

Install

``shell
npm install -g obs-scheduler
`

Usage

`shell
Usage: obs-scheduler [options]

Options:
-V, --version output the version number
-c, --config config file path
-i, --ip-address [address:port] OBS Websocket IP address and port
-p, --password [password] OBS Websocket password
-h, --help display help for command
`

Examples

$3

`json
{
"events": [
{
"name": "Example Event",
"schedule_type": "date",
"date": "2026-01-06T10:00",
"action": "start_recording"
},
{
"name": "Example Event 2",
"schedule_type": "recurring",
// At 14:15 (2:15pm) on each first day of the month.
"schedule": "15 14 1 ",
"action": "start_recording"
}
]
}
`

Notes

config-schema.json takes advantage of options and syntax from json-editor to allow for easy integration into a visual editor.

When writing a configuration file, if you'd like to specify the latest version of the JSON schema for easier writing, you can use the following URL:

`
https://github.com/edonv/obs-scheduler/releases/latest/download/config-schema.json
``

You can also click here to download the latest version of the schema file directly.