{"id":15626923,"url":"https://github.com/muesli/obs-cli","last_synced_at":"2025-04-05T20:07:56.449Z","repository":{"id":39879653,"uuid":"238326539","full_name":"muesli/obs-cli","owner":"muesli","description":"OBS-cli is a command-line remote control for OBS","archived":false,"fork":false,"pushed_at":"2023-03-15T18:59:37.000Z","size":58,"stargazers_count":413,"open_issues_count":20,"forks_count":37,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-29T19:05:35.847Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/muesli.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-02-04T23:15:25.000Z","updated_at":"2025-03-28T15:48:23.000Z","dependencies_parsed_at":"2024-06-18T21:26:37.463Z","dependency_job_id":"54e9b755-17ee-4845-bade-367ebb424b0a","html_url":"https://github.com/muesli/obs-cli","commit_stats":{"total_commits":59,"total_committers":5,"mean_commits":11.8,"dds":"0.22033898305084743","last_synced_commit":"7c0b514d6988ba4582f753de829450a96b943301"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muesli%2Fobs-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muesli%2Fobs-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muesli%2Fobs-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muesli%2Fobs-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/muesli","download_url":"https://codeload.github.com/muesli/obs-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247393570,"owners_count":20931812,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2024-10-03T10:14:27.372Z","updated_at":"2025-04-05T20:07:56.430Z","avatar_url":"https://github.com/muesli.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# obs-cli\n\n[![Latest Release](https://img.shields.io/github/release/muesli/obs-cli.svg)](https://github.com/muesli/obs-cli/releases)\n[![Build Status](https://github.com/muesli/obs-cli/workflows/build/badge.svg)](https://github.com/muesli/obs-cli/actions)\n[![Go ReportCard](https://goreportcard.com/badge/muesli/obs-cli)](https://goreportcard.com/report/muesli/obs-cli)\n[![GoDoc](https://godoc.org/github.com/golang/gddo?status.svg)](https://pkg.go.dev/github.com/muesli/obs-cli)\n\nOBS-cli is a command-line remote control for OBS. It requires the\n[obs-websocket](https://github.com/Palakis/obs-websocket) plugin to be installed\non your system.\n\n## Installation\n\n### Packages \u0026 Binaries\n\nOn Arch Linux you can simply install the package from the AUR:\n\n    yay -S obs-cli\n\nOr download a binary from the [releases](https://github.com/muesli/obs-cli/releases)\npage. Linux (including ARM) binaries are available, as well as Debian and RPM\npackages.\n\n### Build From Source\n\nAlternatively you can also build `obs-cli` from source. Make sure you have a\nworking Go environment (Go 1.12 or higher is required). See the\n[install instructions](https://golang.org/doc/install.html).\n\nTo install obs-cli, simply run:\n\n    go install github.com/muesli/obs-cli@latest\n\n## Usage\n\nAll commands support the following flags:\n\n- `--host`: which OBS instance to connect to\n- `--port`: port to connect to\n- `--password`: password used for authentication\n\n### Streams\n\nChange the streaming state:\n\n```\nobs-cli stream start\nobs-cli stream stop\nobs-cli stream toggle\n```\n\nDisplay streaming status:\n\n```\nobs-cli stream status\n```\n\n### Recordings\n\nChange the recording state:\n\n```\nobs-cli recording start\nobs-cli recording stop\nobs-cli recording toggle\n```\n\nPause or resume a recording:\n\n```\nobs-cli recording pause enable\nobs-cli recording pause resume\nobs-cli recording pause toggle\n```\n\nDisplay recording status:\n\n```\nobs-cli recording status\n```\n\n### Scenes\n\nList all scene names:\n\n```\nobs-cli scene list\n```\n\nShow the current scene name:\n\n```\nobs-cli scene get\n```\n\nSwitch program to a scene:\n\n```\nobs-cli scene current \u003cscene\u003e\n```\n\nSwitch preview to a scene (studio mode must be enabled):\n\n```\nobs-cli scene preview \u003cscene\u003e\n```\n\nSwitch program (studio mode disabled) or preview (studio mode enabled) to a scene:\n\n```\nobs-cli scene switch \u003cscene\u003e\n```\n\n### Scene Collections\n\nList all scene collections:\n\n```\nobs-cli scenecollection list\n```\n\nShow the current scene collection:\n\n```\nobs-cli scenecollection get\n```\n\nSwitch to a scene collection:\n\n```\nobs-cli scenecollection set \u003cscenecollection\u003e\n```\n\n### Scene Items\n\nList all items of a scene:\n\n```\nobs-cli sceneitem list \u003cscene\u003e\n```\n\nChange the visibility of a scene-item:\n\n```\nobs-cli sceneitem show \u003cscene\u003e \u003citem\u003e\nobs-cli sceneitem hide \u003cscene\u003e \u003citem\u003e\nobs-cli sceneitem toggle \u003cscene\u003e \u003citem\u003e\n```\n\nDisplay the visibility of a scene-item:\n\n```\nobs-cli sceneitem visible \u003cscene\u003e \u003citem\u003e\n```\n\nCenter a scene-item horizontally:\n\n```\nobs-cli sceneitem center \u003cscene\u003e \u003citem\u003e\n```\n\n### Labels\n\nChange a FreeType text label:\n\n```\nobs-cli label text \u003clabel\u003e \u003ctext\u003e\n```\n\nTrigger a countdown and continuously update a label with the remaining time:\n\n```\nobs-cli label countdown \u003clabel\u003e \u003cduration\u003e\n```\n\n### Sources\n\nList special sources:\n\n```\nobs-cli source list\n```\n\nToggle mute status of a source:\n\n```\nobs-cli source toggle-mute \u003csource\u003e\n```\n\n### Studio Mode\n\nEnable or disable Studio Mode:\n\n```\nobs-cli studiomode enable\nobs-cli studiomode disable\nobs-cli studiomode toggle\n```\n\nDisplay studio mode status:\n\n```\nobs-cli studiomode status\n```\n\nTransition to program (when the studio mode is enabled):\n\n```\nobs-cli studiomode transition\n```\n\n### Profiles\n\nList all profiles:\n\n```\nobs-cli profile list\n```\n\nShow the current profile:\n\n```\nobs-cli profile get\n```\n\nSwitch to a profile:\n\n```\nobs-cli profile set \u003cprofile\u003e\n```\n\n### Replay Buffer\n\nChange the replay buffer state:\n\n```\nobs-cli replaybuffer start\nobs-cli replaybuffer stop\n```\n\nSave the replay buffer:\n\n```\nobs-cli replaybuffer save\n```\n\nDisplay replay buffer status:\n\n```\nobs-cli replaybuffer status\n```\n\n### Virtual Camera\n\nChange the virtual camera state:\n\n```\nobs-cli virtualcam start\nobs-cli virtualcam stop\nobs-cli virtualcam toggle\n```\n\nDisplay virtual camera status:\n\n```\nobs-cli virtualcam status\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuesli%2Fobs-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmuesli%2Fobs-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuesli%2Fobs-cli/lists"}