xui

discrete terminal twitter client

install

npm install -g @viemccoy/xui

setup

1. go to https://developer.twitter.com/en/portal/dashboard
2. create a new app or use existing one
3. set app permissions to "read and write"
4. go to "keys and tokens" tab
5. regenerate access token & secret (important - must be done after setting write permissions)
6. copy these 4 values:
   • consumer key (api key)
   • consumer secret (api secret)
   • access token
   • access token secret

usage

xui                  # use current default mode

first run will prompt for the 4 credentials above. paste them when prompted.

modes

simple mode (default)

• type directly and press enter to post
• character count shows while typing

vim mode

• starts in insert mode, can use ESC to enter normal mode
• h/j/k/l - move cursor left/down/up/right
• i/a/A/I/o/O - insert modes
• w/b - word movement
• 0/$ - line start/end
• v - visual mode, V - visual line mode
• x/X - delete character
• :w - post tweet
• :q - quit without posting

configuration

set your preferred mode permanently:

xui --vim            # enable vim mode by default
xui --no-vim         # enable simple mode by default (default setting)

these settings persist until changed.

other options

xui --reset-token    # clear stored credentials and reconfigure

features

• simple mode by default, vim mode available
• minimal interface
• real-time character counting
• secure credential storage
• works with premium twitter accounts (unlimited length tweets)
• discrete for workplace use
• persistent mode preferences

requirements

• node.js 14+
• twitter developer account with api access