irccloud

command module
v0.3.1 Latest Latest
Warning

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

Go to latest
Published: Nov 5, 2021 License: MIT Imports: 8 Imported by: 0

README

IRCCloud Terminal Client

Do you miss the R(etro) in IRC? Still have dreams about BitchX? Who doesn't! For all of this to work you need an IRCCloud account. If you're not familiar with IRCCloud, then I think you should check it out!

Live demo!

Navigation

  • Ctrl+Space: Select channel
  • Tab: Auto-complete nicks
  • Ctrl+b: Switch to channel with most recent activity
  • PgUp/PgDown: Scroll in the channel buffer
  • Home, Ctrl+a: Move to the beginning of the line
  • End, Ctrl+e: Move to the end of the line
  • Ctrl+k: Delete from the cursor to the end of the line
  • Ctrl+w: Delete the last word before the cursor
  • Ctrl+u: Delete the entire line

Configuration

A configuration file is automatically generated if you don't already have one, typically the first time you start the client. The file is created in ~/.config/irccloud. Add the username and password you use for IRCCloud. You can also add trigger words (like your own nick) to get special notifications on channels where those trigger words are mentioned. There's also a last_chan field which will be the first channel you see when you start your client, this is set to the channel you were viewing the last time you closed the client. This way you always get back to where you last left off!

username: your_username_here/email
password: secret_password_here
last_chan: '#gonuts'
triggers:
  - cakes
  - my_own_nick
  - cat.gif

Installing

go get -u github.com/termoose/irccloud

Make sure $GOPATH/bin is added to the $PATH variable.

irccloud

On the first run a config file will be generated for you in ~/.config/irccloud, update it with your IRCCloud username and password.

Homebrew
brew install termoose/tap/irccloud-cli
Flatpak (Linux)

Probably soon

TODO

  • Get text input working, return = send text to channel
  • Make sure channel join opens a new buffer
  • Properly quit on Control+C so it doesn't mess up the terminal
  • New query window opened for new private messages
  • Show latest active channels, sorted list of oldest to newest activity
  • Don't quit when we lose websocket connection, display "Reconnecting" dialogue and retry until Ctrl+C
  • Create a loading bar based on numbuffers in oob_include
  • Make auto-completion on nick names in the current channel buffer
  • Add list of trigger names to config, include own nick by default?
  • Special highlight for channels with trigger events in event bar
  • Show timestamps on chat messages
  • Support nick change messages
  • Show non-message data in chat like join/leave events
  • Find out how to change channel view with alt+Fn or something similar
  • Show operator/voice status in channel member list
  • Get and show fancy ANSI splash art, BitchX style!
  • Should we handle multiple servers? Does irccloud do this? How? (it kinda works)
  • Add support for IRCCloud file upload
  • Get image preview in terminal, ascii-render fallback in unsupported terminal
  • Support IRCCloud's pastebin service, query users with very large text inputs if they want to use pastebin service

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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