Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rootmos/twitch-cli
Twitch command line interface
https://github.com/rootmos/twitch-cli
twitch twitch-api twitch-irc
Last synced: 3 months ago
JSON representation
Twitch command line interface
- Host: GitHub
- URL: https://github.com/rootmos/twitch-cli
- Owner: rootmos
- Created: 2020-06-13T11:11:58.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-17T23:32:44.000Z (5 months ago)
- Last Synced: 2024-06-25T15:48:20.833Z (5 months ago)
- Topics: twitch, twitch-api, twitch-irc
- Language: Python
- Homepage:
- Size: 96.7 KB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-twitch-dev - rootmos/twitch-cli - Twitch command line interface. (Libraries / Python)
README
# [Twitch](https://twitch.tv) command line interface
## Features
* manage followed channels
* list videos and active streams of channels
* [dmenu](https://tools.suckless.org/dmenu/) integration to select channels,
videos or streams
* manage stream metadata: title, category
* lurk in chat or interact using per channel unix sockets:
- `twitch-cli chat rootmos2` in one terminal and
`socat readline unix:~/.twitch-cli/channel/rootmos2` in another
([tmux](https://tmux.github.io/) sounds perfect for this, no?)
* follow channels activity: follows and stream up/down events
## Example
The menu option makes for a simple Twitch GUI when paired
with a media player that support Twitch URLs
(I recommend [mpv](https://mpv.io/) and [youtube-dl](https://youtube-dl.org/)).
```shell
twitch-cli list --menu | xargs mpv
```
For a more sophisticated/klickety-klick GUI check out:
[streamlink-twitch-gui](https://streamlink.github.io/streamlink-twitch-gui/),
however it doesn't list videos (at the time of writing).
## Usage
```
usage: twitch-cli [-h] [--log LOG] [--config-path CONFIG_PATH]
[--token-path TOKEN_PATH]
{activity,follow,unfollow,following,list,live,chat,stream,comments}
...
Twitch command line interface
positional arguments:
{activity,follow,unfollow,following,list,live,chat,stream,comments}
sub-commands
activity activity feed
follow follow channel(s)
unfollow unfollow user(s)
following list followed users
list (live) list live streams and videos (default)
chat interact with chat
stream manage stream
comments download comments
optional arguments:
-h, --help show this help message and exit
--log LOG set log level
--config-path CONFIG_PATH
configuration base path (default: ~/.twitch-cli)
--token-path TOKEN_PATH
token path (default: CONFIG_PATH/tokens.json)
```
### list
```
usage: twitch-cli list [-h] [--following] [--exclude PATH]
[--list [FILE [FILE ...]]] [--favorites] [--live]
[--since SINCE] [--title-max-length TITLE_MAX_LENGTH]
[--json] [--menu] [--menu-lines MENU_LINES]
[CHANNEL [CHANNEL ...]]
optional arguments:
-h, --help show this help message and exit
--live list only live streams (synonym for --since=0)
--since SINCE days to list videos
--title-max-length TITLE_MAX_LENGTH
maximum length of printed titles
--json output json
--menu run dmenu
--menu-lines MENU_LINES
number of maximum lines in the menu
channel specification:
CHANNEL list streams and videos of CHANNEL (defaults to
followed channels)
--following
--exclude PATH exclude channel if it appears in the specified file
(default: CONFIG_PATH/exclude)
--list [FILE [FILE ...]]
include channels listed in FILE
--favorites include channels listed in CONFIG_PATH/favorites
```
### chat
```
usage: twitch-cli chat [-h] [--following] [--exclude PATH]
[--list [FILE [FILE ...]]] [--favorites]
[--input-path PATH] [--read-only] [--join-parts]
[CHANNEL [CHANNEL ...]]
optional arguments:
-h, --help show this help message and exit
--input-path PATH create chat input channel at PATH/CHANNEL (default:
CONFIG_PATH/channel)
--read-only lurker mode
--join-parts display who joins and leaves the chat
channel specification:
CHANNEL join CHANNEL's chat
--following
--exclude PATH exclude channel if it appears in the specified file
(default: CONFIG_PATH/exclude)
--list [FILE [FILE ...]]
include channels listed in FILE
--favorites include channels listed in CONFIG_PATH/favorites
```
### activity
```
usage: twitch-cli activity [-h] [--following] [--exclude PATH]
[--list [FILE [FILE ...]]] [--favorites]
[--event [EVENT [EVENT ...]]]
[--notify-live [COMMAND]]
[--notify-follow [COMMAND]]
[CHANNEL [CHANNEL ...]]
optional arguments:
-h, --help show this help message and exit
--event [EVENT [EVENT ...]]
event types: live,follow
--notify-live [COMMAND]
command to run when channel goes live (%c replaced
with channel name, %t with the stream title)
--notify-follow [COMMAND]
command to run when channel goes live (%c is replaced
with channel name, %u with user name)
channel specification:
CHANNEL follow activity feed of CHANNEL
--following
--exclude PATH exclude channel if it appears in the specified file
(default: CONFIG_PATH/exclude)
--list [FILE [FILE ...]]
include channels listed in FILE
--favorites include channels listed in CONFIG_PATH/favorites
```
### stream
```
usage: twitch-cli stream [-h]
{title,set-title,edit-title,category,set-category,edit-category,status}
...
positional arguments:
{title,set-title,edit-title,category,set-category,edit-category,status}
management actions
title print stream title
set-title set stream title
edit-title edit stream title using $EDITOR
category print stream category
set-category set stream category
edit-category edit stream category using $EDITOR
status print stream status
optional arguments:
-h, --help show this help message and exit
```