https://github.com/vilmibm/gh-chat

chatting in the github cli
https://github.com/vilmibm/gh-chat

gh-extension

Last synced: 3 months ago
JSON representation

chatting in the github cli

• Host: GitHub
• URL: https://github.com/vilmibm/gh-chat
• Owner: vilmibm
• Created: 2022-11-29T20:44:16.000Z (about 2 years ago)
• Default Branch: trunk
• Last Pushed: 2023-03-27T23:48:29.000Z (almost 2 years ago)
• Last Synced: 2024-08-03T21:02:52.007Z (5 months ago)
• Topics: gh-extension
• Language: Go
• Homepage:
• Size: 127 KB
• Stars: 8
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-gh-cli-extensions - **chat** - Chatting in the github cli. (Fun)

README

        
# gh chat

_being a joke made as part of the GitHub Client Apps hackathon_

somewhere on a list of "terrible ideas for the github cli" is "realtime chat." naturally adding that as a joke has always amused me, so i finally did it.



## features

- nick list

- invites with push notification

- join/part messages

- visual bell on @ mention

- ephemeral. deletes all messages on host exit.

- figlet support

- emoting

- flood protection (thanks github api)

- SMTP gateway (assuming you haven't muted email gist notifications)

- 1337

## install

`gh ext install vilmibm/gh-chat`

## usage - create a chatroom

prior to launching the new chatroom, the room ID will be printed for copy and pasting.

`gh chat`

## usage - join a chatroom

`gh chat `

a chatroom ID looks like `b6f867cbdd5dcb3e08fca1323fae4db8` and you might see one in your GitHub notifications.

## chat commands

- `/invite ` invite a user to join you. they'll get a GitHub notification.

- `/me ` do an emote

- `/banner ` render your `text` as an ascii banner

- `/banner-font  ` render `text` in the chosen `font`. try `script` or `shadow` for fonts.

- `/quit []` quit chat with optional departure message. you won't see this, but others in the chat will.

## future direction

the extremely high tech backend for this (gist comments) has a fatal

flaw--though @ mentioning someone in a gist comment does generate a

notification that can be seen in web and email, gist notifications are filtered

out of the API response for notifications. this means I can't programmatically

check for chat invites and then interrupt someone's terminal to inform them

they have a chat invite. i think this is a bug in .com and i hope we fix it.