{"id":17992862,"url":"https://github.com/leostera/twitchboard","last_synced_at":"2025-03-26T01:31:33.663Z","repository":{"id":141535015,"uuid":"163223028","full_name":"leostera/twitchboard","owner":"leostera","description":"📺 Real-time Stream Stats Tool for Twitch.tv","archived":false,"fork":false,"pushed_at":"2019-01-02T23:01:33.000Z","size":36,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-02T06:18:55.112Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"OCaml","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/leostera.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-12-26T22:37:42.000Z","updated_at":"2022-02-04T08:39:13.000Z","dependencies_parsed_at":"2023-08-15T23:52:00.654Z","dependency_job_id":"92978bba-6ce4-4424-8724-8f9c0f6e8340","html_url":"https://github.com/leostera/twitchboard","commit_stats":null,"previous_names":["leostera/twitchboard"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leostera%2Ftwitchboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leostera%2Ftwitchboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leostera%2Ftwitchboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leostera%2Ftwitchboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leostera","download_url":"https://codeload.github.com/leostera/twitchboard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222104352,"owners_count":16931744,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-10-29T20:09:27.272Z","updated_at":"2024-10-29T20:09:27.878Z","avatar_url":"https://github.com/leostera.png","language":"OCaml","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 📺 Tw!tchBoard — Real-time Stream Stats Tool for Twitch.tv\n\nAs part of one of the episodes of [Reasonable Coding](https://twitch.tv/ostera) \nwe started building this command-line tool for Twitch.tv to get stream\nstatistics in real-time right in your terminal.\n\n[Watch the stream here](https://www.twitch.tv/videos/354544842) — you're\nwarned: it's really long (~7 hours), due to debugging a TLS error in our http\nlibrary.\n\n**Motivation**. Why on earth? Glad you asked. I mostly live on my terminal, so\nswitching to my phone for the Twitch app or alt-tabbing to a browser in a\ndifferent desktop is very disruptive while streaming.\n\nHaving a small window with the stats, however, is quite okay 👌🏼.\n\nThus began `twitchboard`. \n\nThe scope of it can be seen in the\n[SCOPE.md](https://github.com/ostera/twitchboard/tree/master/SCOPE.md)\ndocument. But we covered quite a few things:\n\n* Built a nice CLI for it\n* Read and Save config files to disk\n* Local HTTP Server serving a static page from memory and handling authentication flows\n* Requests to the Twitch API\n* Modeling the Twitch API into Reason libraries\n* JSON Parsing\n* Tons of Async stuff with Lwt going on!\n* Tons of Low-level HTTPS/TLS things going on too!\n\nIn fact, I've extracted the HTTPS code (which was originally from @anmonteiro) \nand I'll be experimenting with higher-level APIs for building type-safe native \nHTTP/S servers and clients here: [ostera/httpkit](https://github.com/ostera/httpkit).\n\n## Getting Started\n\n\u003e Note: this tool has not been published yet! So you can't install it with `brew`\n\u003e or your favorite package manager. Maybe sometime in the future :)\n\nAs of now you can install with `opam`:\n\n```sh\n$ opam pin add twitchboard git+https://github.com/ostera/twitchboard\n```\n\nOr if you'd rather install from source manually:\n\n```sh\n$ git clone https://github.com/ostera/twitchboard\n$ cd twitchboard\n$ dune build @install\n$ dune install\n```\n\n## Using Twitchboard\n\nThe only flow available right now is the `login` flow:\n\n```sh\nostera/twitchboard λ twitchboard login\nBeginning login flow...\nWelcome, ostera\nYour configuration is saved in ~/.twitchboard/\nYou may start using twitchboard now :)\n```\n\nThis will automatically open up a browser window to do the authentication, and\nwill figure the rest of the thing out for you 🙌🏼— no annoying link copying or\nanything. Just a seamless flow.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleostera%2Ftwitchboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleostera%2Ftwitchboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleostera%2Ftwitchboard/lists"}