README
¶
Welcome home, desune~
A modern terminal IRC client.
senpai is an IRC client that works best with bouncers:
- no logs are kept,
- history is fetched from the server via CHATHISTORY,
- networks are fetched from the server via bouncer-networks,
- messages can be searched in logs via SEARCH,
- files can be uploaded via FILEHOST (with drag & drop!)
Quick demo
To try out senpai "online", a live SSH demo is available at:
ssh -p 6666 delthas.fr
Your nick will be set to your SSH username.
(This connects to the Ergo test network.)
Installing
- From your system package repositories:
senpai - Windows binary: senpai-0.5.0.exe
- From source (requires Go):
git clone https://git.sr.ht/~delthas/senpai
cd senpai
make
sudo make install
Running
From your terminal:
senpai
Senpai will guide you through a configuration assistant on your first run.
Then, type /join #senpai on Libera.Chat and have a... chat!
See doc/senpai.1.scd for more information and doc/senpai.5.scd for more
configuration options!
Debugging errors, testing servers
To debug IRC traffic, run senpai with the -debug argument (or put debug true) in your config, it will then print in the home buffer all the data it sends and receives.
Issue tracker
Browse tickets at https://todo.sr.ht/~delthas/senpai.
To create a ticket, visit the page above, or simply send an email to: u.delthas.senpai@todo.sr.ht (does not require an account)
Contributing
Sending patches to senpai is done by email, this is simple and built-in to Git.
Using pyonji
pyonji streamlines the Git email contribution workflow.
Install, then after adding your changes to a commit, run pyonji.
Using traditional git tools
Set up your system once by following the steps Installation and Configuration of git-send-email.io
Then, run once in this repository:
git config sendemail.to "~delthas/senpai-dev@lists.sr.ht"
Then, to send a patch, make your commit, then run:
git send-email --base=HEAD~1 --annotate -1 -v1
It should then appear on the mailing list.
License
This senpai is open source! Please use it under the ISC license.
Copyright (C) 2021 The senpai Contributors
senpai was created by taiite, who later handed development over to delthas. This is not a fork, but a continuation of the project initially hosted at https://sr.ht/~taiite/senpai/
Documentation
¶
Index ¶
- func BuildVersion() (string, bool)
- func DefaultHighlightPath() (string, error)
- func ParseAddr(addr string, cfg *Config) error
- type App
- func (app *App) Close()
- func (app *App) CurrentBuffer() (netID, buffer string)
- func (app *App) CurrentSession() *irc.Session
- func (app *App) LastMessageTime() time.Time
- func (app *App) OpenLink(in *varlinkservice.OpenLinkIn) (*varlinkservice.OpenLinkOut, error)
- func (app *App) Run()
- func (app *App) SetLastClose(t time.Time)
- func (app *App) SwitchToBuffer(netID, buffer string)
- type Config
- type ReadProgress
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BuildVersion ¶
func DefaultHighlightPath ¶
Types ¶
type App ¶
type App struct {
// contains filtered or unexported fields
}
func (*App) CurrentBuffer ¶
func (*App) CurrentSession ¶
func (*App) LastMessageTime ¶
func (*App) OpenLink ¶ added in v0.5.0
func (app *App) OpenLink(in *varlinkservice.OpenLinkIn) (*varlinkservice.OpenLinkOut, error)
func (*App) SetLastClose ¶
func (*App) SwitchToBuffer ¶
type Config ¶
type Config struct {
Addr string
Nick string
Real string
User string
Password *string
TLS bool
TLSSkipVerify bool
Channels []string
Typings bool
Mouse bool
SpellCheck bool
Highlights []string
OnHighlightPath string
OnHighlightBeep bool
NickColWidth int
ChanColWidth int
ChanColEnabled bool
MemberColWidth int
MemberColEnabled bool
TextMaxWidth int
StatusEnabled bool
Shortcuts map[string][]string
Colors ui.ConfigColors
OpenLink string
Debug bool
Transient bool
LocalIntegrations bool
WithTTY string
WithConsole console.Console
}
Source Files
Directories