Send-slack NPM

Send Slack

A powerful CLI tool to send formatted Markdown messages to Slack using webhooks.

Features

Convert Markdown to Slack blocks
Support for complex Markdown elements (headings, lists, code blocks, etc.)
Automatic splitting of long messages to comply with Slack's limits
Option to send pre-formatted Slack blocks
Add title, context, and start text to your messages
Read input from files or directly from the command line

Installation

npm install -g send-slack

Usage

You can use this package with npx without installing it globally:

npx send-slack [options]

Or if you've installed it globally:

send-slack [options]

Options

Option	Alias	Description	Type	Required
--webhook	-w	Slack webhook URL	string	Yes
--markdown	-m	Markdown string or file path	string	No*
--blocks	-b	JSON string of Slack blocks or file path	string	No*
--title	-t	Heading for the message	string	No
--context	-c	Context array as a JSON string	string	No
--start-text	-s	Start text for the message	string	No
--help	-h	Show help	boolean	No

*Either --markdown or --blocks must be provided

Examples

Send a Markdown message

npx send-slack --webhook "https://hooks.slack.com/services/XXX/YYY/ZZZ" --markdown "# Hello World\n\nThis is a test message."

Send a message from a Markdown file

npx send-slack --webhook "https://hooks.slack.com/services/XXX/YYY/ZZZ" --markdown ./message.md

Send pre-formatted Slack blocks

npx send-slack --webhook "https://hooks.slack.com/services/XXX/YYY/ZZZ" --blocks '[{"type":"section","text":{"type":"mrkdwn","text":"Hello, World!"}}]'

Send a message with a title and context

npx send-slack --webhook "https://hooks.slack.com/services/XXX/YYY/ZZZ" --markdown "This is the main message." --title "Important Announcement" --context '["Posted by: John Doe", "Date: 2023-06-01"]'