kryten-cli 2.6.4

Command-line client for CyTube via kryten-py library

Kryten CLI

Command-line client for sending CyTube commands via the kryten-py library.

Overview

This CLI provides a simple command-line interface to control CyTube channels through the Kryten bridge. It uses the high-level kryten-py library for all communication, making it a clean and maintainable reference implementation.

Installation

From PyPI

pip install kryten-cli

Or with pipx for isolated installation:

pipx install kryten-cli

From Source

pip install -e .

This will automatically install the kryten-py dependency.

Quick Start

The CLI is designed to work without a configuration file. Simply specify the required channel:

kryten --channel myroom say "Hello world"

Command-Line Options

• --channel CHANNEL - CyTube channel name (required)
• --domain DOMAIN - CyTube domain (default: cytu.be)
• --nats URL - NATS server URL (default: nats://localhost:4222), can be specified multiple times
• --config PATH - Path to configuration file (optional, overrides other options)

Examples with Options

Connect to a custom domain:

kryten --channel myroom --domain notcytu.be say "Hi!"

Connect to a remote NATS server:

kryten --channel lounge --nats nats://10.0.0.5:4222 say "Hello"

Use multiple NATS servers for clustering:

kryten --channel lounge --nats nats://host1:4222 --nats nats://host2:4222 say "Hi"

Configuration File (Optional)

For convenience, you can create a config.json file to avoid typing connection details repeatedly:

{
  "nats": {
    "servers": ["nats://localhost:4222"]
  },
  "channels": [
    {
      "domain": "cytu.be",
      "channel": "your-channel-name"
    }
  ]
}

Then use it:

kryten --config config.json say "Hello"

Note: When using --config, you still need to specify --channel as it's always required.

Legacy Format Support: The CLI also supports the older config format with cytube.channel for backward compatibility.

Usage Examples

All examples below assume you're specifying --channel channelname (or using --config).

Chat Commands

Send a chat message:

kryten --channel lounge say "Hello world"

Send a private message:

kryten --channel lounge pm UserName "Hi there!"

Playlist Commands

Add video to end of playlist:

kryten --channel lounge playlist add https://youtube.com/watch?v=xyz
kryten --channel lounge playlist add yt:abc123

Add video to play next:

kryten --channel lounge playlist addnext https://youtube.com/watch?v=abc

Add videos from a playlist file (one URL per line, lines starting with # are ignored):

kryten --channel lounge playlist add .\\playlists\\list.txt
kryten --channel lounge playlist addnext .\\playlists\\friday20.txt

Add as temporary (auto-deleted after playing):

kryten --channel lounge playlist add --temp https://youtube.com/watch?v=xyz

Delete video from playlist:

kryten --channel lounge playlist del video-uid-123

Move video in playlist:

kryten --channel lounge playlist move video-uid-5 after video-uid-3

Jump to specific video:

kryten --channel lounge playlist jump video-uid-7

Clear entire playlist:

kryten --channel lounge playlist clear

Shuffle playlist:

kryten playlist shuffle

Set video temporary status:

kryten playlist settemp video-uid-5 true
kryten playlist settemp video-uid-5 false

Playback Commands

Pause current video:

kryten pause

Resume playback:

kryten play

Seek to timestamp (in seconds):

kryten seek 120.5

Moderation Commands

Kick user:

kryten kick UserName
kryten kick UserName "Stop spamming"

Ban user:

kryten ban UserName
kryten ban UserName "Banned for harassment"

Vote to skip current video:

kryten voteskip

Command Reference

Command	Description
say <message>	Send a chat message
pm <user> <message>	Send a private message
playlist add <url|file>	Add video(s) to end of playlist
playlist addnext <url|file>	Add video(s) to play next
playlist del <uid>	Delete video from playlist
playlist move <uid> after <uid>	Move video in playlist
playlist jump <uid>	Jump to specific video
playlist clear	Clear entire playlist
playlist shuffle	Shuffle playlist
playlist settemp <uid> <true|false>	Set temporary status
pause	Pause playback
play	Resume playback
seek <seconds>	Seek to timestamp
kick <user> [reason]	Kick user from channel
ban <user> [reason]	Ban user from channel
voteskip	Vote to skip current video

Options

Option	Description
--config <path>	Path to config file (default: config.json)
--channel <name>	Override channel from config
--help	Show help message

NATS Message Format

All commands are published to NATS subjects following this pattern:

cytube.commands.{channel}.{action}

Message payload:

{
  "action": "chat",
  "data": {
    "message": "Hello world"
  }
}

This format is compatible with the Kryten bidirectional bridge's CommandSubscriber.

Requirements

• Python 3.11+
• nats-py >= 2.9.0
• Kryten bidirectional bridge running with commands.enabled = true

Examples

Automated DJ

Add a list of videos:

for url in $(cat playlist.txt); do
  kryten playlist add "$url"
  sleep 1
done

Bot Integration

Use in scripts to respond to events:

#!/bin/bash
# Greet new users
kryten say "Welcome to the channel!"

Remote Moderation

Quick moderation commands:

kryten kick TrollUser "Please follow the rules"
kryten ban SpamBot "Automated spam detected"

Troubleshooting

Connection refused

Make sure NATS server is running:

# Start NATS server
nats-server

Command not found

Make sure the CLI is installed:

pip install -e .

Or use the module directly:

python kryten_cli.py say "Hello"

Commands not executing

1. Check that Kryten bridge is running
2. Verify commands.enabled = true in Kryten's config
3. Check NATS connection settings match between CLI and Kryten
4. Verify channel name is correct

Version 2.0 - Using kryten-py Library

Version 2.0 is a complete rewrite that uses the kryten-py library instead of direct NATS calls. This provides:

• Cleaner code: High-level API instead of low-level NATS
• Type safety: Typed interfaces and better IDE support
• Better maintenance: Shares code with other kryten projects
• New features: Automatic URL parsing for media commands

For migration information from v1.x, see MIGRATION.md.

For complete details about the refactor, see REFACTOR_SUMMARY.md.

Contributing

This project serves as a reference implementation for using kryten-py. Contributions are welcome!

License

See LICENSE file for details.