slck/README.md

35 lines
1.1 KiB
Markdown
Raw Normal View History

# slck
[![python-support](https://img.shields.io/badge/python-%5E3.12-brightgreen)]()
## Overview
Clicking around Slack to update statuses is not only annoying, but if you use statuses as part of your remote workflow
to broadcast what you are up to when jumping into new things, you quickly find yourself spending minutes of you day
clicking around and setting the same statuses over and over again since the UI isn't great at remembering them.
Enter `slck`. With it, you can set statuses (with or without expiration dates) without leaving the terminal.
More importantly, you can also set presets and defaults to save time on statuses you reuse all the time.
## Configuration
A configuration YAML file can be used to set up credentials and presets:
```yaml
token: <slack-token>
presets:
<preset-label>:
text: ...
emoji: ...
```
`presets` allows you to set up a map of labels (used to select the preset) to values (defining the status text, emoji).
## Installation
2024-09-13 01:35:34 +00:00
The best way to enjoy this is via pipx:
```
pipx install git+https://forge.karnov.club/marc/slck.git
```