irc-client irc Bash Shell
Need help with birch?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.
dylanaraps

Description

An IRC client written in bash

239 Stars 14 Forks MIT License 331 Commits 2 Opened issues

Services available

Need anything else?

m birch

An IRC client written in bash.

scrot

Features

* Full power of readline for input and keybindings. 

This is thanks to bash's read -e. Birch will read a readline based configuration file from the environment variable '$BIRCH_INPUTRC' which allows you to customize everything.

  • Tab completion of nicks and channels.

    Bash hardcodes read -e tab completion to the file based one. This works fine for channel completion as each channel log is stored in a file anyway. For nick completion, birch will create an empty file for each nick in the channel. Hey, it works.

  • Unique (or semi-unique) nick colors.

    All nicks are colored based on their length. The length is mapped to a color between 1 and 6 which is then used as input for '\033[1;3m'.

Caveats (or limitations)

* Nick column is fixed and truncated to 10 columns wide.

This is something fixable down the line. It merely serves to simplify the alignment of messages into two columns (nick and messages).

  • Lines are word-wrapped to a fixed 60 columns.

    This is also fixable down the line though a lot more painful than the nick column issue. POSIX fold is used to achieve the word wrapping but doesn't take into account non-printable characters and unicode.

    What this means is that wrapping will always be a little off as escape sequences, IRC formatting and unicode will throw out all attempts at calculating the "visible" line length.

    It's an interesting problem to solve. I've made a myriad of attempts at writing a suitable function in bash though they're all too slow (as expected!).

  • No automatic server reconnect.

    This should be fairly easy to fix though I need to figure out the best way of doing so.

  • No SSL (sadly).

    The network connection is through bash's builtin /dev/tcp feature which doesn't allow for SSL.

  • Interesting facts

    * Connection to the IRC server happens without external
    utilities.
    
    

    Bash support network connections via two virtual device directories it "creates" in '/dev/'.

    '/dev/tcp/host/port' and '/dev/udp/host/port'.

    I don't exactly know why these were implemented as it's a crazy feature for a shell to have. I haven't seen them widely used either.

  • The input loop and listener loop can't communicate.

    Birch utilizes two loops to work. One for the input and an additional loop to listen to incoming IRC messages.

    When something is run asynchronously in bash with '&', it runs in a subshell (a second bash process).

    What this means is that the async code can't communicate with the blocking code. Any variables set in the input loop once both loops are running won't be visible in the async listener loop to give an example.

    To work around this birch utilizes files for IPC between the two. The current channel is communicated by maintaining a symlink and checking its target where needed.

    Example: .c -> '#current_channel'

  • This was HARD.

    Trying to make the input prompt and async listener (which spits out messages to the terminal) play nice took a lot of work.

    As birch implements a TUI manually we're dealing with bare escape sequences to tie everything together.

    When a message needs to be printed, the cursor must move from the input prompt to the output area, print the message and finally return back to the input prompt.

    All of this must happen just right to ensure that this series of cursor movements doesn't end up mangling the display of the interface.

    Birch has gone through a lot of rewrites to get this perfect. Fun fact: The older revisions read input char by char and implemented a lot of readline by hand.

  • Usage

    birch 
    
    
    
    

    -s -c -u -p -U -P -x

    -h (help) -v (version)

    Dependencies

    • bash 4+
    • POSIX compatible
      fold
      ,
      rm

    Keybindings

    Ctrl+n - Next buffer.
    Ctrl+p - Previous buffer.
    Tab    - Completion of nicks and channels.
    
    

    Further, all readline keybindings are available for use. See the readline or bash manpages for a list of these.

    Keybindings to birch may also be set via a .inputrc file. Which can be configured by setting $BIRCH_INPUTRC.

    (BIRCH_INPUTRC=/path/to/birch-inputrc birch)

    Commands

    Channels:
    
    

    /join - Join a channel. /part - Leave a channel. /quit - Quit out of birch.

    Messages:

    /msg - Message a user. /me - Send an action.

    Navigation:

    /next - Next buffer. /prev - Previous buffer. / - Buffer by number (0 indexed).

    Other:

    /nick - Change nickname. /names - Display all nicks in channel. /topic - Display channel topic. /away - Set afk message. /raw - Send a raw IRC message.

    Customization

    (These are environment variables.)
    
    

    Set the formatting of the tab line's selected item.

    This defaults to reverse video.

    BIRCH_STATUS='\e[7m'

    The path to a readline based .inputrc file to change

    birch's input settings.

    #

    See http://man7.org/linux/man-pages/man3/readline.3.html

    BIRCH_INPUTRC=/path/to/file

    We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.