https://github.com/okonomi/slkecho
Slkecho is a CLI tool to post message to Slack like echo command.
https://github.com/okonomi/slkecho
ruby-gem slack
Last synced: 4 months ago
JSON representation
Slkecho is a CLI tool to post message to Slack like echo command.
- Host: GitHub
- URL: https://github.com/okonomi/slkecho
- Owner: okonomi
- License: mit
- Created: 2023-12-24T13:56:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-02-02T03:26:21.000Z (5 months ago)
- Last Synced: 2026-02-15T18:12:23.885Z (4 months ago)
- Topics: ruby-gem, slack
- Language: Ruby
- Homepage:
- Size: 631 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Slkecho
[](https://badge.fury.io/rb/slkecho)
Slkecho is a CLI tool to post message to Slack like echo command.
## Installation
Install it yourself as:
```
gem install slkecho
```
or run without installation:
```
gem exec slkecho
```
## Setup
Before using slkecho, you need to configure your Slack API token:
```
slkecho --configure
```
This will:
1. Prompt you to enter your Slack App Client ID and Client Secret
2. Open a browser for OAuth authorization
3. Save the access token to `~/.config/slkecho/token.json`
Once configured, you can use slkecho without the `--token` option.
## Usage
```
slkecho -c -m message
```
or message from stdin:
```
cat message.txt | slkecho -c -m
```
### Options
#### -c, --channel (required)
Slack channel to post message.
See below: https://api.slack.com/methods/chat.postMessage#arg_channel
#### -m, --mention-by-email (optional)
Search for the target member by email address and adds a mentions to the message.
Mention is only valid for members of the channel to which you are posting.
#### --username (optional)
Set user name for message.
See below: https://api.slack.com/methods/chat.postMessage#arg_username
#### --icon-url (optional)
Set user icon image for message by URL.
See below: https://api.slack.com/methods/chat.postMessage#arg_icon_url
#### --icon-emoji (optional)
Set user image for message by emoji.
See below: https://api.slack.com/methods/chat.postMessage#arg_icon_emoji
#### --message-as-blocks (optional)
Post message as blocks.
See below: https://api.slack.com/methods/chat.postMessage#arg_blocks
#### --token (optional)
Pass a token to authenticate with Slack.
#### --configure (optional)
Configure Slack API token via OAuth 2.0 authentication.
Saves token to `~/.config/slkecho/token.json` (or `$XDG_CONFIG_HOME/slkecho/token.json`).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/okonomi/slkecho.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).