Skip to main content

Pipe command output to Slack from your terminal!

Project description


<p align="center">
<img src="https://s3.amazonaws.com/assets.nickficano.com/slackcat.svg" height="64">
<h2 align="center">SlackCat</h3>
<p align="center">Concatenate files(s), or <code>stdin</code>, directly to Slack.<br>
3-minute setup & no third-party integration required.
<p align="center">
<a href="https://pypi.python.org/pypi/slackcat/"><img src="https://img.shields.io/pypi/pyversions/slackcat.svg" alt="pypi"></a>
<a href="https://pypi.python.org/pypi/slackcat/"><img src="https://img.shields.io/pypi/v/slackcat.svg" alt="pypi"></a>
<img src="https://img.shields.io/badge/pip_dependencies-0-brightgreen.svg" alt="pip dependencies">
</p>
</p>

### Get SlackCat

Download using pip via pypi.

```bash
pip install slackcat
```

Next, head to the [Slack Incoming WebHooks Configuration](https://slack.com/apps/A0F7XDUAZ-incoming-webhooks), click
the ``Add Configuration`` button and set the default configuration values to your
liking. Once complete, copy the Webhook URL which we'll need in the next step.

Open your ``~/.bash_profile`` file add following:

```bash

export SLACKCAT_WEBHOOK_URL="https://hooks.slack.com/services/TXXX/BXXXX/XXXXXXXXXXXXXXXXXXXXXXXX"
```

_Make sure to replace the "https://hooks.slack.com/services/..." with the one provided above._

### Usage

```bash

# - "Hey what's your public key dog?"
slackcat @doug ~/.ssh/id_rsa.pub

# - "Do we still use that crypto library written by the Cheese Cake Factory?"
grep -r 'from cheesecake.factory import x509' ./ | slackcat @paul

# - "Are you sure it's on your path?"
echo $PATH | slackcat "#general"

# - "These queries filling up in syslog look suspicious"
tail -f /var/log/syslog | slackcat "#general" -f
```

### Customization

If you would like to override the bot's username, add the following line to your ``~/.bash_profile`` file:

```bash

export SLACKCAT_USERNAME="abraham-linksys"
```

If you would like to override the bot's icon image, add the following line to your ``~/.bash_profile`` file:

```bash

export SLACKCAT_ICON_URL="http://via.placeholder.com/500x500.png"
```

### Development
Development of "SlackCat" is facilitated exclusively on GitHub. Contributions in the form of patches, tests and feature creation and/or requests are very welcome and highly encouraged. Please open an issue if this tool does not function as you'd expect.

**How to release updates**

If this is the first time you're releasing to pypi, you'll need to run: ``pip install -r tests/dev_requirements.txt``.

Once complete, execute the following commands:

```bash

git checkout master

# Increment the version number and tag the release.
bumpversion [major|minor|patch]

# Upload the distribution to PyPi
python setup.py sdist bdist_wheel upload

# Since master often contains work-in-progress changes, increment the version
# to a patch release to prevent inaccurate attribution.
bumpversion --no-tag patch

git push origin master --tags
```

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

slackcat-2.0.0.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

slackcat-2.0.0-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file slackcat-2.0.0.tar.gz.

File metadata

  • Download URL: slackcat-2.0.0.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for slackcat-2.0.0.tar.gz
Algorithm Hash digest
SHA256 64c3accbb2484fa3cd1b1194f841ab1ade16150b630726095c511c5fec4e9459
MD5 1e2e0ff340f1ed0e1431502f54970fb0
BLAKE2b-256 57bee0d76b0ba3d9df002da0943489a661882e3eee5456655f1aad6e65dd1815

See more details on using hashes here.

File details

Details for the file slackcat-2.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for slackcat-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8489c6bd36f7f2ad772efd86fa854247afc164cd62434ab28dfd2c57f362e8f7
MD5 693fe1a1d2c0d17680bdddfc73dc2297
BLAKE2b-256 7a7382e093b9ec6b0064f9235656aa47404364c1456123c4749676a04ec1da8f

See more details on using hashes here.

Supported by

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