From e4353d7626147c90dc76e9800a02e59203c58e08 Mon Sep 17 00:00:00 2001 From: onyx-and-iris Date: Tue, 10 Jun 2025 22:53:14 +0100 Subject: [PATCH] token is now required patch bump --- README.md | 5 +++-- pyproject.toml | 2 +- src/slobs_cli/cli.py | 5 ++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c99684f..a9dade3 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) -A command line interface for Streamlabs Desktop +A command line interface for the Streamlabs Desktop websocket API. For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md) @@ -21,6 +21,7 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md) - Python 3.10 or greater - [Streamlabs Desktop][sl-desktop] +- A websocket token: Settings > Remote Control > API Token ## Installation @@ -44,7 +45,7 @@ The CLI should now be discoverable as `slobs-cli` - --domain/-d: Streamlabs client domain - --port/-p Streamlabs client port -- --token/-t: Remote Control API Token +- --token/-t: API Token Pass `--domain`, `--port` and `--token` as flags on the root command, for example: diff --git a/pyproject.toml b/pyproject.toml index ad8a2ea..b7d0c21 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "slobs-cli" -version = "0.7.4" +version = "0.7.5" description = "A command line application for Streamlabs Desktop" authors = [{ name = "onyx-and-iris", email = "code@onyxandiris.online" }] dependencies = ["pyslobs>=2.0.4", "asyncclick>=8.1.8"] diff --git a/src/slobs_cli/cli.py b/src/slobs_cli/cli.py index 3618a33..6235129 100644 --- a/src/slobs_cli/cli.py +++ b/src/slobs_cli/cli.py @@ -28,12 +28,11 @@ from pyslobs import ConnectionConfig, SlobsConnection help="The token for the SLOBS server.", envvar="SLOBS_TOKEN", show_envvar=True, + required=True, ) @click.pass_context async def cli(ctx: click.Context, domain: str, port: int, token: str | None): - """ - Command line interface for SLOBS. - """ + """Command line interface for Streamlabs Desktop.""" ctx.ensure_object(dict) config = ConnectionConfig( domain=domain,