tuickly

command module
v0.0.0-...-ab933d4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 24, 2026 License: MIT Imports: 11 Imported by: 0

README

tuickly

tuickly

HEAVY IN DEVELOPMENT / WORK IN PROGRESS

Your own TUI for Twitch. Powered by Bubble Tea and Helix. Name comes from tickly which itself comes from tCLI.

Preview

tuickly

Prerequisites

Installation

Currently, only manually, very soon will be on AUR.

git clone https://github.com/ealexandrohin/tuickly.git

Usage

cd tuickly && go run .

Vim-style movement:

  • h/j/k/l to get around
  • Ctrl+h/j/k/l to change UX elements
  • g/G go to top/bottom
  • ? for help

To change account/reauth:

  1. Exit tuickly
  2. Delete $HOME/.config/tuickly/auth.gob
  3. Open again

Roadmap

  • Merge PR for Helix #245
  • Merge PR for Bubbles #871
  • Fix refreshing tokens
Distribution
  • Git releases
  • Binary releases
  • AUR
UI
  • Live page
    • Open stream/s
    • Select multiple streams
    • Change sorting
  • Sidebar
    • Open stream
    • Change sorting
  • Help
    • Show all keybinds
    • Search keybinds
  • Settings page
    • Hot reloading
    • Change startup configuration
  • Category page
    • Change sorting
  • Profile page
  • Follows page
    • Change sorting
  • Stream page
    • Watch stream
  • Search page
    • Search users
    • Search streams
    • Search categories

?

  • Downloads page
    • Download stream/s
    • Download clip
UX
  • Tab management
    • Open new tab
    • Close tab
    • Rename tab
  • Hide/open sidebar
  • Search in each UX element
  • Auto-resizing
  • Accept argv
  • Use chafa/chafa-go
Configuration
  • Use .json or .conf file for configuration
  • Reauth
  • Custom themes
  • Custom keybinds
  • Change startup config

Configuration

$HOME/.config/tuickly

Contribution

Feel free to contribute! Also, I'd be happy to hear advice or recommendations.

Documentation

Overview

Package tuickly is Twitch TUI

Directories

Path Synopsis
Package auth is Bubble Tea model that handles auth for the Twitch API
Package auth is Bubble Tea model that handles auth for the Twitch API
Package cmds defines Bubble Tea commands
Package cmds defines Bubble Tea commands
Package consts consits of global constants
Package consts consits of global constants
Package ctx defines context which gets passed around (•ᴗ-)
Package ctx defines context which gets passed around (•ᴗ-)
Package errs is for errors, ofc
Package errs is for errors, ofc
Package msgs defines Bubble Tea messages
Package msgs defines Bubble Tea messages
ui
Package ui provides the main UI Bubble Tea model
Package ui provides the main UI Bubble Tea model
colors
Package colors...
Package colors...
footer
Package footer provides Bubble Tea model for footer
Package footer provides Bubble Tea model for footer
header
Package header provides Bubble Tea model for header
Package header provides Bubble Tea model for header
keymap
Package keymap lists all of the keybindings
Package keymap lists all of the keybindings
sizes
Package sizes is part of Styles package that describes sizes of UI/UX elements
Package sizes is part of Styles package that describes sizes of UI/UX elements
styles
Package styles defines all the lipgloss styles used for rendering UI, including colors, sizes, and borders.
Package styles defines all the lipgloss styles used for rendering UI, including colors, sizes, and borders.
Package utils are utils, duh
Package utils are utils, duh
ux
Package ux consolidates UX models
Package ux consolidates UX models
items/stream
Package stream defines struct for a single Twitch stream for lists
Package stream defines struct for a single Twitch stream for lists
pacman
Package pacman provides a custom pacman spinner
Package pacman provides a custom pacman spinner
sidelist
Package sidelist provides the item delegate for sidebar list
Package sidelist provides the item delegate for sidebar list
streamlist
Package streamlist provides the item delegate for main stream list
Package streamlist provides the item delegate for main stream list

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL