Options:¶

-h, --help

Show the help message and exit.

-v, --version

Show the version and exit.

-p PORT, --port PORT

Set the port number. The default is 9007.

-i IP, --ip IP

Set the IP (Ipv4 only) address to listen to. The default is 127.0.0.1.

-t TOKENFILE, --tokenfile TOKENFILE

Set the token file. The default is ~/.localslackirc.

-c TOKENFILE, --cookiefile TOKENFILE

Set the cookie file. This is only used on slack, and is only useful if your token starts with "xoxc".

-u, --nouserlist

Don't display userlist in the IRC client.

-j, --autojoin

Automatically join all remote channels.

-o, --override

Allow listening on addresses that do not start with 127.*
This is potentially dangerous.

--downloads-directory

Where to create files for automatic downloads. It defaults to /tmp.
The directory must exist and be writeable. Files will automatically be downloaded in it.
No cleaning is automatically performed on it by localslackirc.

--formatted-max-lines

Maximum amount of lines in a formatted text to send to the client rather than store in a file.
When people send logs or otherwise long text content as formatted text, the end result is usually hardly readable in IRC, having the username of the sender and the time in each line.
This option sets a limit for formatted content to be sent as text.
When the limit is exceeded, the formatted text will be stored as a .txt file instead and its URL will be shown in the IRC client.
The files will be saved in the path specified by "downloads directory".
The files are not automatically removed.
Setting to 0 (the default) will send everything to the client and create no text files.

-f --status-file

Path to the file keeping the status. When this is set, it allows for the history to be loaded on start.

--silenced-yellers

Comma separated list of nicknames and channels that are prevented from using general mentions (@here, @channel, @everyone, and the likes).
Since some people are greatly abusing the feature, this is to make them less annoying.
Their messages aren't blocked and are shown as "yelling MESSAGE", but the nickname of the user won't be injected in the message, so the IRC client won't create a notification.
The channels must begin with #.
The threads created from a silenced channel will also be silenced.

-d --debug

Enables debugging logs.

--log-suffix

Instead of using localslackirc as ident for syslog, this appends a custom string, separated by a -.
This is useful when running several instances, to be able to distinguish the logs.
The default .service file uses this. Of course journald keeps track of the services but this makes it easier to have the information on text dumps or other logging daemons such as rsyslog.

--ignored-channels

Comma separated list of channels to ignore and not automatically join on IRC.
It is ignored unless autojoin is set.
If a channel is in this list, the IRC client will not automatically join it, but on slack you will still be inside the channel
This is useful to avoid off topic channels in which coworkers who can't take a hint keep re-inviting.
The ignored channels can be joined again if needed, with a /join #channel command. However the conversation history will not be fetched.
For channel names containing non ascii characters, their ascii representation needs to be used. Use /list to see which that is.

--no-rejoin-on-mention

Normally localslackirc will automatically join channel and threads if someone mentions the user.
When this is set the mentions will be ignored and no channels or threads will be joined upon mention.

--control-socket CONTROL_SOCKET

When used, localslackirc will create a unix socket in the specified path, that can be used by the various lsi-* commands to interact with localslackirc.
Before an IRC client connects to localslackirc, the process is in a dormant unconnected state and is not connected to slack. For this reason the control socket exists only when an IRC client is connected.