{"id":16615585,"url":"https://github.com/pschmitt/obs-cli","last_synced_at":"2026-05-16T11:05:29.639Z","repository":{"id":172757432,"uuid":"649732314","full_name":"pschmitt/obs-cli","owner":"pschmitt","description":"CLI for controlling OBS Studio","archived":false,"fork":false,"pushed_at":"2026-05-07T14:23:45.000Z","size":144,"stargazers_count":90,"open_issues_count":4,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-05-07T16:36:13.303Z","etag":null,"topics":["obs","obs-studio","obs-studio-websocket","websockets"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/obs-cli/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pschmitt.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["pschmitt"],"custom":["https://www.paypal.com/paypalme/pppschmitt"]}},"created_at":"2023-06-05T14:09:59.000Z","updated_at":"2026-05-07T14:30:28.000Z","dependencies_parsed_at":"2024-03-11T20:50:40.157Z","dependency_job_id":"6231b031-4e98-4f84-89cd-97c1814c259f","html_url":"https://github.com/pschmitt/obs-cli","commit_stats":null,"previous_names":["pschmitt/obs-cli"],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/pschmitt/obs-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschmitt%2Fobs-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschmitt%2Fobs-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschmitt%2Fobs-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschmitt%2Fobs-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pschmitt","download_url":"https://codeload.github.com/pschmitt/obs-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pschmitt%2Fobs-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33100321,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-16T04:41:52.686Z","status":"ssl_error","status_checked_at":"2026-05-16T04:41:52.009Z","response_time":115,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["obs","obs-studio","obs-studio-websocket","websockets"],"created_at":"2024-10-12T02:09:55.857Z","updated_at":"2026-05-16T11:05:29.635Z","avatar_url":"https://github.com/pschmitt.png","language":"Python","funding_links":["https://github.com/sponsors/pschmitt","https://www.paypal.com/paypalme/pppschmitt"],"categories":[],"sub_categories":[],"readme":"# 🎬🎥 OBS CLI\n\n`obs-cli` is a command-line interface for OBS Studio.\n\nIt allows you to control OBS Studio from the command line, making it easier to\nautomate scene switching, source toggling, and more.\n\nThis implementation of `obs-cli` is:\n\n- written in Python 3\n- powered by [rich](https://github.com/Textualize/rich),\n  [rich-argparse](https://github.com/hamdanal/rich-argparse), and\n  [obsws-python](https://pypi.org/project/obsws-python/).\n\n⚠️ Only the new OBS WebSocket API (v5) is supported!\n\n## 💻 Installation\n\n```shell\n# uv (recommended)\nuv tool install obs-cli\n\n# pip\npip install --user obs-cli\n```\n\n## 🛠️ Usage\n\n```shell\nobs-cli --help\n```\n\nGlobal flags (`-H`, `-P`, `-p`, `-j`, `-q`, `-D`) can be placed before or\nafter the subcommand name. Subcommands also accept plural forms (`scenes`,\n`items`, `groups`, etc.) and default to `list` (or `status` for stateful\ncommands) when no action is given.\n\n```shell\nobs-cli scenes               # same as: obs-cli scene list\nobs-cli items --json         # JSON output\nobs-cli --json scene list    # equivalent\n```\n\n## 🌟 Features\n\n### 🎞️ Scene Management\n\n```shell\nobs-cli scene --help\n```\n\n```shell\n# List all scenes (INDEX / NAME / CURRENT columns)\nobs-cli scene list\nobs-cli scenes               # plural alias\n\n# Switch to a scene\nobs-cli scene switch \"Scene2\"\n\n# Print the current scene name\nobs-cli scene current\n\n# Screenshot — current scene or a named one\nobs-cli scene screenshot -o scene.png\nobs-cli scene screenshot \"Scene2\" -o scene2.png\nobs-cli scene screenshot --raw \u003e scene.png   # raw bytes to stdout\nobs-cli scene screenshot --json              # base64-encoded JSON\n```\n\n### 📦 Item Management\n\n```shell\nobs-cli item --help\n```\n\n```shell\n# List all items in the current (or a named) scene\nobs-cli item list\nobs-cli item list --scene \"Scene2\"\nobs-cli items                # plural alias\n\n# Show / hide / toggle a source\nobs-cli item show --scene \"Scene2\" \"Item1\"\nobs-cli item hide --scene \"Scene2\" \"Item1\"\nobs-cli item toggle \"Item1\"\n\n# Screenshot a source\nobs-cli item screenshot \"Webcam\" -o webcam.png\nobs-cli item screenshot \"Webcam\" --raw \u003e webcam.png\nobs-cli item screenshot \"Webcam\" --json\nobs-cli item screenshot \"Webcam\" -f jpg -o webcam.jpg\n```\n\n### 📂 Group Management\n\n```shell\nobs-cli group --help\n```\n\n```shell\n# List all groups in a scene\nobs-cli group list\nobs-cli group list --scene \"Scene2\"\nobs-cli groups               # plural alias\n\n# Show / hide / toggle a group\nobs-cli group show --scene \"Scene2\" \"group1\"\nobs-cli group hide --scene \"Scene2\" \"group1\"\nobs-cli group toggle \"group1\"\n```\n\n### 🎬 Source Management\n\nSources are the underlying named resources (cameras, media files, browser\nsources, etc.) that exist independently of any scene. This differs from\n`item`, which is a source *instance* placed inside a specific scene.\n\n```shell\nobs-cli source --help\n```\n\n```shell\n# List all sources\nobs-cli source list\nobs-cli sources              # plural alias\n\n# Screenshot any source by name — no scene context needed\nobs-cli source screenshot \"Nyan Cat\" -o nyancat.png\nobs-cli source screenshot \"Webcam\" --raw \u003e webcam.png\nobs-cli source screenshot \"Webcam\" --raw | feh -\nobs-cli source screenshot \"Webcam\" --json\nobs-cli source screenshot \"Webcam\" --width 320 -o thumb.png\n\n# Check whether a source is active and/or showing\nobs-cli source active \"Webcam\"\nobs-cli source active \"Webcam\" --json\nobs-cli -q source active \"Webcam\"  # exits 0 if active, 1 if not\n```\n\n### 🎤 Input Management\n\n```shell\nobs-cli input --help\n```\n\n```shell\n# List all inputs\nobs-cli input list\nobs-cli inputs               # plural alias\n\n# Show all settings for an input\nobs-cli input get \"Mic/Aux\"\n\n# Get a single property\nobs-cli input get \"Webcam\" device_id\n\n# Set a property\nobs-cli input set \"Webcam\" device_id /dev/v4l/by-id/usb-Elgato_Elgato_Facecam_FW52K1A04919-video-index0\n\n# Mute / unmute / toggle\nobs-cli input mute \"Mic/Aux\"\nobs-cli input unmute \"Mic/Aux\"\nobs-cli input toggle-mute \"Mic/Aux\"\nobs-cli input is-muted \"Mic/Aux\"\n```\n\n### 🎨 Filter Management\n\n```shell\nobs-cli filter --help\n```\n\n```shell\n# List filters on a source\nobs-cli filter list \"Mic/Aux\"\nobs-cli filters              # plural alias (current scene)\n\n# Enable / disable / toggle\nobs-cli filter enable  \"Mic/Aux\" \"Filter1\"\nobs-cli filter disable \"Mic/Aux\" \"Filter1\"\nobs-cli filter toggle  \"Mic/Aux\" \"Filter1\"\n\n# Check status (exits 0 if enabled, 1 if disabled)\nobs-cli filter status \"Mic/Aux\" \"Filter1\"\nobs-cli -q filter status \"Mic/Aux\" \"Filter1\"\n```\n\n### ⌨️ Hotkey Management\n\n```shell\nobs-cli hotkey --help\n```\n\n```shell\n# List all hotkeys\nobs-cli hotkey list\nobs-cli hotkeys              # plural alias\n\n# Trigger a hotkey\nobs-cli hotkey trigger \"OBSBasic.StartStreaming\"\n```\n\n### 🎥 Virtual Camera\n\n```shell\nobs-cli virtualcam status\nobs-cli virtualcam start\nobs-cli virtualcam stop\nobs-cli virtualcam toggle\n```\n\n### 📡 Stream Management\n\n```shell\nobs-cli stream status\nobs-cli stream start\nobs-cli stream stop\nobs-cli stream toggle\n```\n\n### 📹 Recording\n\n```shell\nobs-cli record status\nobs-cli record start\nobs-cli record stop\nobs-cli record toggle\n```\n\n### 🔁 Replay Buffer\n\n```shell\nobs-cli replay status\nobs-cli replay start\nobs-cli replay stop\nobs-cli replay toggle\nobs-cli replay save\n```\n\n## 📄 License\n\nThis project is licensed under the GPL-3.0 License.\n\nSee [LICENSE](LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpschmitt%2Fobs-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpschmitt%2Fobs-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpschmitt%2Fobs-cli/lists"}