streamerslive

README

streamerslive

Command-line tool and Go library to fetch streaming channels from Youtube or Twitch.

Installation

You can grab a binary from releases.

Commands

add

Adds channels with the provided URLs to the list displayed by list. Multiple URLs are divided by one or more spaces.

streamerslive add https://www.twitch.tv/harukakaribu https://www.twitch.tv/gamesdonequick https://www.youtube.com/channel/UCPZgBtMYoFKypEG2SCvBN9A

list

Displays saved streaming channels.

$ streamerslive list
+----+----------------+--------------------------------+
| ID |    CHANNEL     |          STREAM TITLE          |
+----+----------------+--------------------------------+
|  1 | arikacaribu    |                                |
|  2 | gamesdonequick | Awesome Games Done Quick 2021  |
|    |                | Online - Benefiting Prevent    |
|    |                | Cancer Foundation - Pokémon    |
|    |                | Platinum                       |
|  3 | rosedoodle     | 🌸「 😳 welcome to the COMFY   |
|    |                | zone 🌹💖|| beepu beepu!       |
|    |                | ✨」🌸【VTuber】               |
+----+----------------+--------------------------------+

remove

Removes a channel from list.

$ streamerslive remove 3
rosedoodle removed

watch

Opens stream in default browser.

streamerslive watch 2

Documentation

Index

• Variables
• type Channel
  • func SortByName(cs []Channel) []Channel
• type ChannelsClient
  • func NewChannelsClient(twitchAPICredentials TwitchAPICredentials) *ChannelsClient
  • func (cc *ChannelsClient) ChannelFromURL(url string) (*Channel, error)
• type Stream
• type TwitchAPICredentials

Variables

var (
	// ErrInvalidTwitchAPICredentials is the error thrown
	// when provided invalid Twitch API credentials
	ErrInvalidTwitchAPICredentials = errors.New("invalid Twitch API credentials")
	// ErrInvalidURL is the error thrown when URL is invalid
	ErrInvalidURL = errors.New("invalid URL")
)

Types

type Channel

type Channel struct {
	URL  string
	Name string
	// Stream is nil when channel is not streaming
	Stream *Stream
}

Channel represents a Youtube or Twitch channel

func SortByName

func SortByName(cs []Channel) []Channel

SortByName returns a slice of channels sorted by name

type ChannelsClient

type ChannelsClient struct {
	// contains filtered or unexported fields
}

ChannelsClient provides the client instance to get streams info

func NewChannelsClient

func NewChannelsClient(twitchAPICredentials TwitchAPICredentials) *ChannelsClient

NewChannelsClient creates a new ChannelsClient instance with provided credentials

func (*ChannelsClient) ChannelFromURL

func (cc *ChannelsClient) ChannelFromURL(url string) (*Channel, error)

ChannelFromURL fetches a channel's information

type Stream

type Stream struct {
	Title string
	URL   string
}

Stream represents a YouTube or Twitch stream

type TwitchAPICredentials

type TwitchAPICredentials struct {
	ClientID       string
	AppAccessToken string
}

TwitchAPICredentials are required to get info from Twitch streams. Check https://dev.twitch.tv/docs/authentication