slack-term

command module
v0.0.0-...-65b5114 Latest Latest
Warning

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

Go to latest
Published: Jul 7, 2026 License: MIT Imports: 13 Imported by: 0

README

slack-term

A Slack client for your terminal.

A fork of jpbruinsslot/slack-term (module was erroneousboat/slack-term), revived after Slack retired the RTM API and given terminal-native navigation upgrades.

Screenshot

What's different in this fork

Upstream stopped working once Slack removed the legacy RTM API and tokens. This fork modernizes auth and rethinks navigation for people with a lot of conversations:

  • User-token auth (xoxp-) — acts as you: sees every conversation you're in and posts as you. RTM is gone, so new messages are discovered by lightweight polling (~2s) of the channel you're viewing. (A Socket Mode/bot approach was tried and rejected — a bot only sees channels it's invited to and posts as itself.)
  • Sectioned "Messages" rail — grouped under Recently, Channels, DMs, and Multi-person DMs, with header-skipping cursor movement.
  • Readable group-DM names — Slack's internal mpdm-you--alice--bob-1 renders as alice, bob.
  • Collapsible sections — multi-person DMs (often hundreds) start collapsed with a count; z toggles the current section, Z expands all.
  • Fast navigation — Ctrl-f/Ctrl-b page the list, }/{ jump between sections.
  • Scoped search — /#term channels, /@term DMs, /%term group DMs; plain /term searches everything (auto-expanding collapsed sections).
  • Message-body colors — distinct theme colors for @mentions, links, and `code`.
  • Persistent Shortcuts panel — an always-visible cheatsheet; the Threads panel stacks beneath it when a channel has threads.
  • Headless subcommands — slack-term send <channel> <msg> [thread-ts] posts a message; slack-term stream <channel> emits new messages as JSONL for scripts and agents.

Setup differs from upstream (you provide a Slack user token) — see SETUP.md.

Installation

Binary installation

Download a compatible binary for your system. For convenience, place slack-term in a directory where you can access it from the command line. Usually this is /usr/local/bin.

$ mv slack-term /usr/local/bin
Via Go
$ go install github.com/iampoundcake/slack-term@latest
Via docker

You can also run it with docker, make sure you have a valid config file on your host system.

docker run -it -v [config-file]:/config erroneousboat/slack-term

Setup

  1. Get a slack token, click here

  2. Running slack-term for the first time, will create a default config file at ~/.config/slack-term/config.

$ slack-term
  1. Update the config file and update your slack_token For more configuration options of the config file, see the wiki.
{
    "slack_token": "yourslacktokenhere"
}

Usage

When everything is setup correctly you can run slack-term with the following command:

$ slack-term

Default Key Mapping

Below are the default key-mappings for slack-term, you can change them in your config file.

mode key action
command i insert mode
command / search mode
command k move channel cursor up
command j move channel cursor down
command g move channel cursor top
command G move channel cursor bottom
command K thread up
command J thread down
command G move channel cursor bottom
command pg-up scroll chat pane up
command ctrl-b scroll chat pane up
command ctrl-u scroll chat pane up
command pg-down scroll chat pane down
command ctrl-f scroll chat pane down
command ctrl-d scroll chat pane down
command n next search match
command N previous search match
command , jump to next notification
command q quit
command f1 help
insert left move input cursor left
insert right move input cursor right
insert enter send message
insert esc command mode
search esc command mode
search enter command mode

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