Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: 10 days 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 (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-07T04:05:10.000Z (about 1 month ago)
- Last Synced: 2024-10-12T18:50:37.748Z (26 days ago)
- Topics: ruby-gem, slack
- Language: Ruby
- Homepage:
- Size: 385 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
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 add this line to your application's Gemfile:
```
source "https://rubygems.pkg.github.com/okonomi" do
gem "slkecho"
end
```
More details: [Working with the RubyGems registry - GitHub Docs](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry#installing-a-package)
## 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
## 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).