Skip to main content

A terminal Slack client built on Textual

Project description

slak

Python License

A terminal Slack client built on Textual.

Unofficial. Uses Slack's internal browser protocol and may violate Slack's TOS. Not affiliated with Slack Technologies, LLC.

Features

Keyboard-first. Borderless Textual UI — workspace rail, channel sidebar, message pane, compose. The compose box is focused on launch, so you just start typing. Tab cycles focus, Ctrl+P opens the command palette (every action), and F1 shows the full keybinding reference.

Workspaces & navigation

  • Multiple workspaces with concurrent live connections; Alt+1Alt+9 jump, Ctrl+W opens a filterable switcher.
  • Ctrl+K fuzzy channel/DM finder; Alt+←/Alt+→ walk channel history; Ctrl+B toggles the sidebar, Ctrl+T the thread panel.
  • Cache-first startup: your last context renders instantly while sync runs behind it.

Messaging

  • Send, edit (Ctrl+E), and delete messages; reactions (Ctrl+R); threads with a follow-the-cursor reply panel.
  • Ctrl+N new-message composer (DM and group DM); @/: mention & emoji autocomplete; Ctrl+O opens link(s) in a message; Space previews image attachments.
  • In-channel (Ctrl+F) and workspace-wide (Ctrl+Shift+F) search.
  • Typing indicators, both directions.

Sidebar

  • Slack-native sections (users.channelSections.list, linked-list order) with a pinned ★ Starred section, or config-glob sections ([sections.<name>]) as a fallback — grouped, collapsible, live-updated on section/star events.
  • A ⚑ Threads row opens the threads view (your subscribed threads, newest-reply first). DM and group-DM names are resolved to member display names.

Rendering

  • Slack markdown, mentions, custom emoji (inline images on kitty), and Block Kit / legacy attachments (headers, sections, fields, context, dividers, controls).
  • Inline images for files and attachments — kitty graphics on kitty, half-blocks on any truecolor terminal.
  • Space previews the selected message's image full-screen. Default is an in-terminal preview (works over SSH); set [appearance] image_preview = gui to open it in an external viewer on the local machine instead.
  • ~70-slot color themes (12 built-in incl. terminal-following ansi-dark/ansi-light, plus ~/.config/slak/themes/*.toml and [theme] overrides), switched live with Ctrl+Y; the sidebar is auto-kept contrasting (CIELAB).
  • Optional user avatars beside messages ([appearance] avatars = on, off by default) — rendered as 4×2 half-blocks in a left gutter.
  • Private channels show a padlock — the single-width `` glyph when an installed font covers it (Nerd Font / FontAwesome, detected via fontconfig), else a narrow fallback (`[appearance] nerd_font = auto|on|off`).

Realtime & integration

  • RTM with exponential-backoff reconnection and missed-history backfill.
  • Desktop notifications, presence/DND, terminal tab-title unread indicator.
  • Opt-in embedded MCP server ([mcp] enabled = true) — an AI client reads your context (slak_get_context) and drafts a reply (slak_set_draft, draft-only). Run the adapter with slak --mcp (pip install 'slak[mcp]').

Underneath: a pluggable SlackClient (browser-cookie auth, with an in-memory fake for offline/dev), a self-healing SQLite cache (WAL + FTS5), and round-trippable TOML config. ~340 tests.

Not yet wired: the sixel image protocol (half-blocks cover non-kitty terminals).

Install

Recommended — pipx installs it isolated and puts slak on your PATH globally:

pipx install slak
pipx install 'slak[mcp]'   # with the optional MCP adapter

Or with pip (ideally in a virtualenv):

pip install slak

Either way you get a slak command:

slak --help

Use a real workspace

slak --add-workspace      # paste your browser xoxc token + d cookie
slak                      # connects to it (falls back to demo if no token)
slak --demo               # always use the seeded demo workspace

Develop

python3 -m venv .venv && . .venv/bin/activate
pip install -e ".[dev]"

python -m slak                      # run against a seeded demo workspace
textual run --dev slak/dev.py       # run with live CSS hot-reload
textual console                      # (separate terminal) stream logs
pytest                               # run the test suite

The look is themeable CSS — edit slak/ui/styles/app.tcss while running under --dev to restyle instantly.

License

GNU General Public License v3.0 or later.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

slak-0.1.4.tar.gz (149.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

slak-0.1.4-py3-none-any.whl (119.5 kB view details)

Uploaded Python 3

File details

Details for the file slak-0.1.4.tar.gz.

File metadata

  • Download URL: slak-0.1.4.tar.gz
  • Upload date:
  • Size: 149.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for slak-0.1.4.tar.gz
Algorithm Hash digest
SHA256 a169914294d99dacdaecfec6a3b7224b459e5f5176173d5a5daa45f5740abc86
MD5 49292ba743e28be627ce8ba08052fd3a
BLAKE2b-256 42a95a01201b04d5b223ef1b597d3d1bd99c765df26963b8b8851e4e93fb1b5e

See more details on using hashes here.

Provenance

The following attestation bundles were made for slak-0.1.4.tar.gz:

Publisher: release.yml on Frodotus/slak

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file slak-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: slak-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 119.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for slak-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 fc169976650d53f31916af5683acfb9aaa9402c56123df6e62fc762b3f1739af
MD5 73e1abf615fd33f45874bb936a87a786
BLAKE2b-256 91277fb28e6249520b9b46056b14faa6fa0519b655200738f795abbd58fdbdfc

See more details on using hashes here.

Provenance

The following attestation bundles were made for slak-0.1.4-py3-none-any.whl:

Publisher: release.yml on Frodotus/slak

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page